class OperatingModeInformation

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
operating_modeuint32Operating mode
device_handleDeviceHandleDevice matching operating mode (if applicable)

Member functions

Function nameReturn typeInput typeDescription
operating_mode() constuint32voidReturns the current value of operating_mode. If the operating_mode is not set, returns 0.
set_operating_mode()voiduint32Sets the value of operating_mode. After calling this, operating_mode() will return value.
clear_operating_mode()voidvoidClears the value of operating_mode. After calling this, operating_mode() will return the empty string/empty bytes.
has_device_handle() constboolvoidReturns true if device_handle is set.
device_handle()const DeviceHandle&voidReturns 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 *voidReturns 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()voidvoidClears 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()voidDeviceHandle *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 *voidReleases 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++)