class ArmStateInformation

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
active_stateuint32Arm active state
connectionConnectionConnection information of the last processed command which triggered an arm state change

Member functions

Function nameReturn typeInput typeDescription
active_state() constuint32voidReturns the current value of active_state. If the active_state is not set, returns 0.
set_active_state()voiduint32Sets the value of active_state. After calling this, active_state() will return value.
clear_active_state()voidvoidClears the value of active_state. After calling this, active_state() will return the empty string/empty bytes.
has_connection() constboolvoidReturns true if connection is set.
connection()const Connection&voidReturns the current value of connection. If connection is not set, returns a Connection with none of its fields set (possibly connection::default_instance()).
mutable_connection()Connection *voidReturns a pointer to the mutable Connection object that stores the field's value. If the field was not set prior to the call, then the returned Connection will have none of its fields set (i.e. it will be identical to a newly-allocated Connection). After calling this, has_connection() will return true and connection() will return a reference to the same instance of Connection.
clear_connection()voidvoidClears the value of the field. After calling this, has_connection() will return false and connection() will return the default value.
set_allocated_connection()voidConnection *Sets the Connection object to the field and frees the previous field value if it exists. If the Connection pointer is not NULL, the message takes ownership of the allocated Connection object and has_ Connection() will return true. Otherwise, if the connection is NULL, the behavior is the same as calling clear_connection().
release_connection()Connection *voidReleases the ownership of the field and returns the pointer of the Connection object. After calling this, caller takes the ownership of the allocated Connection object, has_connection() will return false, and connection() will return the default value.

Parent topic: Base (C++)