Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 2.67 KB

File metadata and controls

25 lines (19 loc) · 2.67 KB

class SafetyThreshold

Member values

Member name Data type Description
handle SafetyHandle Identifies safety to configure
value float32 Safety threshold value

Member functions

Function name Return type Input type Description
has_handle() const bool void Returns true if handle is set.
handle() const SafetyHandle& void Returns the current value of handle. If handle is not set, returns a SafetyHandle with none of its fields set (possibly handle::default_instance()).
mutable_handle() SafetyHandle * void Returns a pointer to the mutable SafetyHandle object that stores the field's value. If the field was not set prior to the call, then the returned SafetyHandle will have none of its fields set (i.e. it will be identical to a newly-allocated SafetyHandle). After calling this, has_handle() will return true and handle() will return a reference to the same instance of SafetyHandle.
clear_handle() void void Clears the value of the field. After calling this, has_handle() will return false and handle() will return the default value.
set_allocated_handle() void SafetyHandle * Sets the SafetyHandle object to the field and frees the previous field value if it exists. If the SafetyHandle pointer is not NULL, the message takes ownership of the allocated SafetyHandle object and has_ SafetyHandle() will return true. Otherwise, if the handle is NULL, the behavior is the same as calling clear_handle().
release_handle() SafetyHandle * void Releases the ownership of the field and returns the pointer of the SafetyHandle object. After calling this, caller takes the ownership of the allocated SafetyHandle object, has_handle() will return false, and handle() will return the default value.
value() float32 void Returns the current value of value. If the value is not set, returns 0.
set_value() void float32 Sets the value of value. After calling this, value() will return value.
clear_value() void void Clears the value of value. After calling this, value() will return 0.

Parent topic: DeviceConfig (C++)