Member values
| Member name | Data type | Description |
|---|---|---|
| servoing_mode | uint32 | New servoing mode |
| timestamp | Timestamp | Event timestamp |
| user_handle | UserProfileHandle | User that caused the servoing mode event |
| connection | Connection | Connection that caused the servoing mode event |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| servoing_mode() const | uint32 | void | Returns the current value of servoing_mode. If the servoing_mode is not set, returns 0. |
| set_servoing_mode() | void | uint32 | Sets the value of servoing_mode. After calling this, servoing_mode() will return value. |
| clear_servoing_mode() | void | void | Clears the value of servoing_mode. After calling this, servoing_mode() will return the empty string/empty bytes. |
| has_timestamp() const | bool | void | Returns true if timestamp is set. |
| timestamp() | const Timestamp& | void | Returns the current value of timestamp. If timestamp is not set, returns a Timestamp with none of its fields set (possibly timestamp::default_instance()). |
| mutable_timestamp() | Timestamp * | void | Returns a pointer to the mutable Timestamp object that stores the field's value. If the field was not set prior to the call, then the returned Timestamp will have none of its fields set (i.e. it will be identical to a newly-allocated Timestamp). After calling this, has_timestamp() will return true and timestamp() will return a reference to the same instance of Timestamp. |
| clear_timestamp() | void | void | Clears the value of the field. After calling this, has_timestamp() will return false and timestamp() will return the default value. |
| set_allocated_timestamp() | void | Timestamp * | Sets the Timestamp object to the field and frees the previous field value if it exists. If the Timestamp pointer is not NULL, the message takes ownership of the allocated Timestamp object and has_ Timestamp() will return true. Otherwise, if the timestamp is NULL, the behavior is the same as calling clear_timestamp(). |
| release_timestamp() | Timestamp * | void | Releases the ownership of the field and returns the pointer of the Timestamp object. After calling this, caller takes the ownership of the allocated Timestamp object, has_timestamp() will return false, and timestamp() will return the default value. |
| has_user_handle() const | bool | void | Returns true if user_handle is set. |
| user_handle() | const UserProfileHandle& | void | Returns the current value of user_handle. If user_handle is not set, returns a UserProfileHandle with none of its fields set (possibly user_handle::default_instance()). |
| mutable_user_handle() | UserProfileHandle * | void | Returns a pointer to the mutable UserProfileHandle object that stores the field's value. If the field was not set prior to the call, then the returned UserProfileHandle will have none of its fields set (i.e. it will be identical to a newly-allocated UserProfileHandle). After calling this, has_user_handle() will return true and user_handle() will return a reference to the same instance of UserProfileHandle. |
| clear_user_handle() | void | void | Clears the value of the field. After calling this, has_user_handle() will return false and user_handle() will return the default value. |
| set_allocated_user_handle() | void | UserProfileHandle * | Sets the UserProfileHandle object to the field and frees the previous field value if it exists. If the UserProfileHandle pointer is not NULL, the message takes ownership of the allocated UserProfileHandle object and has_ UserProfileHandle() will return true. Otherwise, if the user_handle is NULL, the behavior is the same as calling clear_user_handle(). |
| release_user_handle() | UserProfileHandle * | void | Releases the ownership of the field and returns the pointer of the UserProfileHandle object. After calling this, caller takes the ownership of the allocated UserProfileHandle object, has_user_handle() will return false, and user_handle() will return the default value. |
| has_connection() const | bool | void | Returns true if connection is set. |
| connection() | const Connection& | void | Returns 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 * | void | Returns 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() | void | void | Clears the value of the field. After calling this, has_connection() will return false and connection() will return the default value. |
| set_allocated_connection() | void | Connection * | 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 * | void | Releases 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++)