Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 2.94 KB

OperatingModeInformation.md

File metadata and controls

25 lines (19 loc) · 2.94 KB

class OperatingModeInformation

Member values

Member name Data type Description
operating_mode uint32 Operating mode
device_handle DeviceHandle Device matching operating mode (if applicable)

Member functions

Function name Return type Input type Description
operating_mode() const uint32 void Returns the current value of operating_mode. If the operating_mode is not set, returns 0.
set_operating_mode() void uint32 Sets the value of operating_mode. After calling this, operating_mode() will return value.
clear_operating_mode() void void Clears the value of operating_mode. After calling this, operating_mode() will return the empty string/empty bytes.
has_device_handle() const bool void Returns true if device_handle is set.
device_handle() const DeviceHandle& void Returns the current value of device_handle. If device_handle is not set, returns a DeviceHandle with none of its fields set (possibly device_handle::default_instance()).
mutable_device_handle() DeviceHandle * void Returns a pointer to the mutable DeviceHandle object that stores the field's value. If the field was not set prior to the call, then the returned DeviceHandle will have none of its fields set (i.e. it will be identical to a newly-allocated DeviceHandle). After calling this, has_device_handle() will return true and device_handle() will return a reference to the same instance of DeviceHandle.
clear_device_handle() void void Clears the value of the field. After calling this, has_device_handle() will return false and device_handle() will return the default value.
set_allocated_device_handle() void DeviceHandle * Sets the DeviceHandle object to the field and frees the previous field value if it exists. If the DeviceHandle pointer is not NULL, the message takes ownership of the allocated DeviceHandle object and has_ DeviceHandle() will return true. Otherwise, if the device_handle is NULL, the behavior is the same as calling clear_device_handle().
release_device_handle() DeviceHandle * void Releases the ownership of the field and returns the pointer of the DeviceHandle object. After calling this, caller takes the ownership of the allocated DeviceHandle object, has_device_handle() will return false, and device_handle() will return the default value.

Parent topic: Base (C++)