Parent class for all report rules.
More...
#include <attribute_reporting.h>
|
static constexpr uint16_t | min_size |
| Minimum pack/unpack required data size.
|
|
Parent class for all report rules.
Definition at line 168 of file attribute_reporting.h.
◆ Rule()
HF::Core::AttributeReporting::Rule::Rule |
( |
Type |
type | ) |
|
|
inlineprotected |
Constructor.
- Parameters
-
[in] | type | Report reference type of this rule. |
Definition at line 198 of file attribute_reporting.h.
Reference report
Report reference this rule generates.
◆ pack()
uint16_t HF::Core::AttributeReporting::Rule::pack |
( |
Common::ByteArray & |
array, |
|
|
uint16_t |
offset = 0 |
|
) |
| const |
Write the object on to a ByteArray so it can be sent over the network.
The buffer passed in MUST have enough size to hold the serialized object, e.g.,
Serializable obj;
ByteArray payload(obj.size());
obj.pack(payload);
- Parameters
-
[in,out] | array | ByteArray reference to write the object to. |
[in] | offset | offset to start writing to. |
- Returns
- the number of bytes written.
◆ size()
uint16_t HF::Core::AttributeReporting::Rule::size |
( |
| ) |
const |
Number bytes needed to serialize the message.
- Returns
- number of bytes the message requires to be serialized.
◆ unpack()
uint16_t HF::Core::AttributeReporting::Rule::unpack |
( |
const Common::ByteArray & |
array, |
|
|
uint16_t |
offset = 0 |
|
) |
| |
Read a message from a ByteArray.
- Parameters
-
[in] | array | ByteArray reference to read the message from. |
[in] | offset | offset to start reading from. |
- Returns
- the number of bytes read.
The documentation for this struct was generated from the following file: