Member values
| Member name | Data type | Description |
|---|---|---|
| name | string | Name of the component |
| version | string | Version of the component |
| device_id | uint32 | Device id of the component |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| name() | const string& | void | Returns the current value of name. If name is not set, returns the empty string/empty bytes. |
| set_name() | void | const string& | Sets the value of name. After calling this, name() will return a copy of value. |
| set_name() | void | string&& | (C++11 and beyond): Sets the value of name, moving from the passed string. After calling this, name() will return a copy of value. |
| set_name() | void | const char* | Sets the value of name using a C-style null-terminated string. After calling this, name() will return a copy of value. |
| mutable_name() | string * | void | Returns a pointer to the mutable string object that stores name's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, name() will return whatever value is written into the given string. |
| clear_name() | void | void | Clears the value of name. After calling this, name() will return the empty string/empty bytes. |
| set_allocated_name() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_name(). |
| release_name() | string * | void | Releases the ownership of name and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and name() will return the empty string/empty bytes. |
| version() | const string& | void | Returns the current value of version. If version is not set, returns the empty string/empty bytes. |
| set_version() | void | const string& | Sets the value of version. After calling this, version() will return a copy of value. |
| set_version() | void | string&& | (C++11 and beyond): Sets the value of version, moving from the passed string. After calling this, version() will return a copy of value. |
| set_version() | void | const char* | Sets the value of version using a C-style null-terminated string. After calling this, version() will return a copy of value. |
| mutable_version() | string * | void | Returns a pointer to the mutable string object that stores version's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, version() will return whatever value is written into the given string. |
| clear_version() | void | void | Clears the value of version. After calling this, version() will return the empty string/empty bytes. |
| set_allocated_version() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_version(). |
| release_version() | string * | void | Releases the ownership of version and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and version() will return the empty string/empty bytes. |
| device_id() | uint32 | void | Returns the current value of device_id. If the device_id is not set, returns 0. |
| set_device_id() | void | uint32 | Sets the value of device_id. After calling this, device_id() will return value. |
| clear_device_id() | void | void | Clears the value of device_id. After calling this, device_id() will return 0. |
Parent topic: Base (C++)