isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation Class Reference

A helper class that groups product rate infomation together. A TC server could use this to know quickly what rates are available and how to interact with them. Use the associated element number and DDI to perform value commands and requests with a client. More...

#include <isobus_device_descriptor_object_pool_helpers.hpp>

Collaboration diagram for isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation:

Public Member Functions
bool	is_valid () const
	Returns true if any rate information is populated.

Public Attributes
RateMetadata	rateSetpoint
	The info needed to interact with the rate setpoint.
RateMetadata	rateActual
	The info needed to get the actual rate.
RateMetadata	rateDefault
	The info needed to interact with the default rate.
RateMetadata	rateMinimum
	The info needed to interact with the minimum rate.
RateMetadata	rateMaximum
	The info needed to interact with the maximum rate.
std::uint16_t	elementNumber = NULL_OBJECT_ID
	The element number of the bin, which can be used to avoid further parsing of the DDOP when issuing commands.

Detailed Description

A helper class that groups product rate infomation together. A TC server could use this to know quickly what rates are available and how to interact with them. Use the associated element number and DDI to perform value commands and requests with a client.

Definition at line 78 of file isobus_device_descriptor_object_pool_helpers.hpp.

Member Function Documentation

is_valid()

bool isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::is_valid

(

)

const

Returns true if any rate information is populated.

Returns

true if any rate information is populated, otherwise false

Definition at line 35 of file isobus_device_descriptor_object_pool_helpers.cpp.

Member Data Documentation

elementNumber

std::uint16_t isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::elementNumber = NULL_OBJECT_ID

The element number of the bin, which can be used to avoid further parsing of the DDOP when issuing commands.

Definition at line 90 of file isobus_device_descriptor_object_pool_helpers.hpp.

rateActual

RateMetadata isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::rateActual

The info needed to get the actual rate.

Definition at line 86 of file isobus_device_descriptor_object_pool_helpers.hpp.

rateDefault

RateMetadata isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::rateDefault

The info needed to interact with the default rate.

Definition at line 87 of file isobus_device_descriptor_object_pool_helpers.hpp.

rateMaximum

RateMetadata isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::rateMaximum

The info needed to interact with the maximum rate.

Definition at line 89 of file isobus_device_descriptor_object_pool_helpers.hpp.

rateMinimum

RateMetadata isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::rateMinimum

The info needed to interact with the minimum rate.

Definition at line 88 of file isobus_device_descriptor_object_pool_helpers.hpp.

rateSetpoint

RateMetadata isobus::DeviceDescriptorObjectPoolHelper::ProductControlInformation::rateSetpoint

The info needed to interact with the rate setpoint.

Definition at line 85 of file isobus_device_descriptor_object_pool_helpers.hpp.

---

The documentation for this class was generated from the following files:

• isobus/include/isobus/isobus/isobus_device_descriptor_object_pool_helpers.hpp
• isobus/src/isobus_device_descriptor_object_pool_helpers.cpp