class SafetyInformation

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescriptionUsage
handleSafetyHandleSafety handle that this information is aboutTo set handle, you simply assign a value directly to a field within handle. You can also use the parent message's HasField() method to check if a message type field value has been set.
can_change_safety_stateboolTrue if related safety configuration can be modifiedYou can manipulate the field can_change_safety_state as if it were a regular field. To clear the value of can_change_safety_state and reset it to the default value for its type, you call the ClearField() method of the Message interface.
has_warning_thresholdboolTrue if safety status can go in WarningYou can manipulate the field has_warning_threshold as if it were a regular field. To clear the value of has_warning_threshold and reset it to the default value for its type, you call the ClearField() method of the Message interface.
has_error_thresholdboolTrue if safety status can go in ErrorYou can manipulate the field has_error_threshold as if it were a regular field. To clear the value of has_error_threshold and reset it to the default value for its type, you call the ClearField() method of the Message interface.
limit_typeintSafety limit typeYou can manipulate the field limit_type as if it were a regular field. To clear the value of limit_type and reset it to the default value for its type, you call the ClearField() method of the Message interface.
default_warning_thresholdfloatDefault warning threshold (if 'limit_type' is either MINIMAL_LIMIT or MAXIMAL_LIMIT and 'has_warning_threshold' is true)You can manipulate the field default_warning_threshold as if it were a regular field. To clear the value of default_warning_threshold and reset it to the default value for its type, you call the ClearField() method of the Message interface.
default_error_thresholdfloatDefault error threshold (if 'limit_type' is either MINIMAL_LIMIT or MAXIMAL_LIMIT and 'has_error_threshold' is true)You can manipulate the field default_error_threshold as if it were a regular field. To clear the value of default_error_threshold and reset it to the default value for its type, you call the ClearField() method of the Message interface.
upper_hard_limitfloatMaximal threshold value (if 'limit_type' is either MINIMAL_LIMIT or MAXIMAL_LIMIT)You can manipulate the field upper_hard_limit as if it were a regular field. To clear the value of upper_hard_limit and reset it to the default value for its type, you call the ClearField() method of the Message interface.
lower_hard_limitfloatMinimal threshold value (if 'limit_type' is either MINIMAL_LIMIT or MAXIMAL_LIMIT)You can manipulate the field lower_hard_limit as if it were a regular field. To clear the value of lower_hard_limit and reset it to the default value for its type, you call the ClearField() method of the Message interface.
statusintCurrent Safety statusYou can manipulate the field status as if it were a regular field. To clear the value of status and reset it to the default value for its type, you call the ClearField() method of the Message interface.
unitintUnit that the safety status is inYou can manipulate the field unit as if it were a regular field. To clear the value of unit and reset it to the default value for its type, you call the ClearField() method of the Message interface.

Parent topic: DeviceConfig (Python)