|
TReK Python
5.3.2
Telemetry/Command API
|
This class describes the status associated with a parameter value. More...
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and destruction. | |
| def | ParameterStatus (trek_status: int=0, src_status: int=0) -> None |
| Class initializer. More... | |
| def | copy (copy_from: object) -> None |
| Copies the contents of the provided 'copy_from' ParameterStatus into this ParameterStatus. More... | |
Manage Status | |
Functions used for setting/getting/resetting status. | |
| def | clear_all_limits () -> None |
| Clears all bits assoicated with low, high, and delta limits status. | |
| def | clear_all_expected_states () -> None |
| Clears all bits assoicated with expected states in the status. | |
| def | get_source_status () -> int |
| Gets the current source status value. More... | |
| def | get_status_string () -> str |
| Returns the status as a string. More... | |
| def | get_trek_status () -> int |
| Gets the current TReK status value. More... | |
| def | reset () -> None |
| Resets the parameter status values to zero. | |
| def | reset_source_status () -> None |
| Resets the source status value to zero. | |
| def | reset_trek_status () -> None |
| Resets the TReK status value to zero. | |
| def | set_status (trek_status: int, src_status: int) -> None |
| Sets the status with two integers. More... | |
Check Error Conditions | |
Functions that check the error conditions by bit or class of bits. | |
| def | has_calibration_error () -> bool |
| Determines if there is a calbration error. More... | |
| def | has_delta_limit_error () -> bool |
| Determines if a delta limit error is set. More... | |
| def | has_expected_state_error () -> bool |
| Determines if there is an expected state error. More... | |
| def | has_high_limit_error () -> bool |
| Determines if a high limit error is set. More... | |
| def | has_level1_delta_limit_error () -> bool |
| Determines if there is a level 1 delta limit error. More... | |
| def | has_level1_high_limit_error () -> bool |
| Determines if there is a level 1 high limit error. More... | |
| def | has_level1_low_limit_error () -> bool |
| Determines if there is a level 1 low limit error. More... | |
| def | has_level2_delta_limit_error () -> bool |
| Determines if there is a level 2 delta limit error. More... | |
| def | has_level2_high_limit_error () -> bool |
| Determines if there is a level 2 high limit error. More... | |
| def | has_level2_low_limit_error () -> bool |
| Determines if there is a level 2 low limit error. More... | |
| def | has_level3_delta_limit_error () -> bool |
| Determines if there is a level 3 delta limit error. More... | |
| def | has_level3_high_limit_error () -> bool |
| Determines if there is a level 3 high limit error. More... | |
| def | has_level3_low_limit_error () -> bool |
| Determines if there is a level 3 low limit error. More... | |
| def | has_level4_delta_limit_error () -> bool |
| Determines if there is a level 4 delta limit error. More... | |
| def | has_level4_high_limit_error () -> bool |
| Determines if there is a level 4 high limit error. More... | |
| def | has_level4_low_limit_error () -> bool |
| Determines if there is a level 4 low limit error. More... | |
| def | has_level5_delta_limit_error () -> bool |
| Determines if there is a level 5 delta limit error. More... | |
| def | has_level5_high_limit_error () -> bool |
| Determines if there is a level 5 high limit error. More... | |
| def | has_level5_low_limit_error () -> bool |
| Determines if there is a level 5 low limit error. More... | |
| def | has_limit_error () -> bool |
| Determines if any limit error is set. More... | |
| def | has_low_limit_error () -> bool |
| Determines if a low limit error is set. More... | |
| def | has_range_error () -> bool |
| Determines if there is a range error. More... | |
| def | has_source_caution_limit () -> bool |
| Determines if the source data indicates a caution limit. More... | |
| def | has_source_warning_limit () -> bool |
| Determines if the source data indicates a warning limit. More... | |
| def | has_stale_data () -> bool |
| Determines if the data is stale. More... | |
| def | has_trek_error () -> bool |
| Determines if there is any TReK error. More... | |
Flag Error Conditions | |
Functions that set the error condition bits. | |
| def | set_alarm_switch_error () -> None |
| Sets the status bit to indicate that an alarm switch error occurred. More... | |
| def | set_calibration_general_error () -> None |
| Sets the status bit to indicate that a calibration error has occured. More... | |
| def | set_calibration_illegal_datatype_error () -> None |
| Sets the status bit to indicate that an illegal data type for calibration error has occured. More... | |
| def | set_calibration_switch_error () -> None |
| Sets the status bit to indicate that a calibration switch error occurred. More... | |
| def | set_conversion_error () -> None |
| Sets the status bit to indicate that a conversion error has occured. More... | |
| def | set_data_loss_possible_error () -> None |
| Sets the status bit to indicate that data may have been lost (e.g., getting a float value as an integer). More... | |
| def | set_data_quality_bad_length_error () -> None |
| Sets the status bit to indicate that a length error has occured. More... | |
| def | set_data_quality_checksum_error () -> None |
| Sets the status bit to indicate that a checksum error has occured. More... | |
| def | set_expected_state_error () -> None |
| Sets the status bit to indicate that an expected state error has occured. More... | |
| def | set_high_range_error () -> None |
| Sets the status bit to indicate that a high range error has occured. More... | |
| def | set_level1_delta_limit () -> None |
| Sets the status bit to indicate that a level 1 delta error has occured. More... | |
| def | set_level1_high_limit () -> None |
| Sets the status bit to indicate that a level 1 high error has occured. More... | |
| def | set_level1_low_limit () -> None |
| Sets the status bit to indicate that a level 1 low error has occured. More... | |
| def | set_level2_delta_limit () -> None |
| Sets the status bit to indicate that a level 2 delta error has occured. More... | |
| def | set_level2_high_limit () -> None |
| Sets the status bit to indicate that a level 2 high error has occured. More... | |
| def | set_level2_low_limit () -> None |
| Sets the status bit to indicate that a level 2 low error has occured. More... | |
| def | set_level3_delta_limit () -> None |
| Sets the status bit to indicate that a level 3 delta error has occured. More... | |
| def | set_level3_high_limit () -> None |
| Sets the status bit to indicate that a level 3 high error has occured. More... | |
| def | set_level3_low_limit () -> None |
| Sets the status bit to indicate that a level 3 low error has occured. More... | |
| def | set_level4_delta_limit () -> None |
| Sets the status bit to indicate that a level 4 delta error has occured. More... | |
| def | set_level4_high_limit () -> None |
| Sets the status bit to indicate that a level 4 high error has occured. More... | |
| def | set_level4_low_limit () -> None |
| Sets the status bit to indicate that a level 4 low error has occured. More... | |
| def | set_level5_delta_limit () -> None |
| Sets the status bit to indicate that a level 5 delta error has occured. More... | |
| def | set_level5_high_limit () -> None |
| Sets the status bit to indicate that a level 5 high error has occured. More... | |
| def | set_level5_low_limit () -> None |
| Sets the status bit to indicate that a level 5 low error has occured. More... | |
| def | set_low_range_error () -> None |
| Sets the status bit to indicate that a low range error has occured. More... | |
| def | set_processing_error () -> None |
| Sets the status bit to indicate that a processing error has occured. More... | |
| def | set_source_status_as_string (interp: bool) -> None |
| Sets whether or not the source status is interpreted as characters. More... | |
| def | set_source_status_error (error_mask: int) -> None |
| Sets the source status. More... | |
| def | set_stale_data () -> None |
| Sets the status bit to indicate that data is stale. More... | |
This class describes the status associated with a parameter value.
The parameter status is a series of bit fields and associated status characters that describe important processing information with a parameter's value.
| ParameterStatus | ( | trek_status | : int |