HF::Core::AttributeReporting::Reference Struct Reference

Report Identifier. More...

#include <attribute_reporting.h>

Inheritance diagram for HF::Core::AttributeReporting::Reference:

Collaboration diagram for HF::Core::AttributeReporting::Reference:

Public Member Functions
	Reference (uint8_t _type=0, uint8_t _id=0)
	Constructor. More...
uint16_t	size () const
	Number bytes needed to serialize the message. More...
uint16_t	pack (Common::ByteArray &array, uint16_t offset=0) const
	Write the object on to a ByteArray so it can be sent over the network. More...
uint16_t	unpack (const Common::ByteArray &array, uint16_t offset=0)
	Read a message from a ByteArray. More...

Data Fields
uint8_t	type: 1
	Report type : PERIODIC or EVENT.
uint8_t	id: 7
	Report ID. More...

Static Public Attributes
static constexpr uint16_t	min_size = sizeof(uint8_t)
	Minimum pack/unpack required data size.

Detailed Description

Report Identifier.

Definition at line 108 of file attribute_reporting.h.

Constructor & Destructor Documentation

Reference()

HF::Core::AttributeReporting::Reference::Reference ( uint8_t  _type = 0, uint8_t  _id = 0  )

inline

Constructor.

Parameters

[in]	_type	report type, PERIODIC or EVENT.
[in]	_id	report id.

Definition at line 119 of file attribute_reporting.h.

                                                         :
               type(_type), id(_id)
            {}

Member Function Documentation

pack()

uint16_t HF::Core::AttributeReporting::Reference::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::Reference::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::Reference::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.

Field Documentation

id

uint8_t HF::Core::AttributeReporting::Reference::id

Report ID.

Definition at line 111 of file attribute_reporting.h.

---

The documentation for this struct was generated from the following file:

• attribute_reporting.h