A helper class that groups a DDI with an object id. More...
#include <isobus_device_descriptor_object_pool_helpers.hpp>
Inheritance diagram for isobus::DeviceDescriptorObjectPoolHelper::RateMetadata:
Collaboration diagram for isobus::DeviceDescriptorObjectPoolHelper::RateMetadata:
Public Attributes | |
| std::uint16_t | dataDictionaryIdentifier = static_cast<std::uint16_t>(DataDescriptionIndex::Reserved) |
| The data dictionary index of the product control rate. | |
| std::uint16_t | objectID = NULL_OBJECT_ID |
| The object ID of the rate. | |
Friends | |
| class | DeviceDescriptorObjectPoolHelper |
| Allow our helper to change the values. | |
Additional Inherited Members | |
 Public Member Functions inherited from isobus::DeviceDescriptorObjectPoolHelper::ObjectPoolValue | |
| ObjectPoolValue ()=default | |
| Default constructor for ObjectPoolValue which defaults the value to being non-existant and not settable. | |
| operator bool () const | |
| overloads the bool operator so that you can check for this value's existence by doing if(thisObject) | |
| bool | exists () const |
| Returns if this variable exists. A variable exists if it was either provided in the DDOP, or has been set manually as part of a DPD value command. | |
| bool | editable () const |
| Returns if this value is editable. DPDs are editable. DPTs are not. | |
| std::int32_t | get () const |
| Returns the value. If the value doesn't exist this will return 0. | |
| Protected Attributes inherited from isobus::DeviceDescriptorObjectPoolHelper::ObjectPoolValue | |
| std::int32_t | value = 0 |
| The value being wrapped by this object. | |
| bool | isValuePresent = false |
| Stores if the value has ever been set. | |
| bool | isSettable = false |
| Stores if the value can be set, such as on a DPD's value. | |
Detailed Description
A helper class that groups a DDI with an object id.
Definition at line 65 of file isobus_device_descriptor_object_pool_helpers.hpp.
Friends And Related Symbol Documentation
◆ DeviceDescriptorObjectPoolHelper
|
friend |
Allow our helper to change the values.
Definition at line 72 of file isobus_device_descriptor_object_pool_helpers.hpp.
Member Data Documentation
◆ dataDictionaryIdentifier
| std::uint16_t isobus::DeviceDescriptorObjectPoolHelper::RateMetadata::dataDictionaryIdentifier = static_cast<std::uint16_t>(DataDescriptionIndex::Reserved) |
The data dictionary index of the product control rate.
Definition at line 68 of file isobus_device_descriptor_object_pool_helpers.hpp.
◆ objectID
| std::uint16_t isobus::DeviceDescriptorObjectPoolHelper::RateMetadata::objectID = NULL_OBJECT_ID |
The object ID of the rate.
Definition at line 69 of file isobus_device_descriptor_object_pool_helpers.hpp.
The documentation for this class was generated from the following file:
- isobus/include/isobus/isobus/isobus_device_descriptor_object_pool_helpers.hpp
