HF::Core::DeviceManagement::RegisterMessage Struct Reference

Register command message. More...

#include <device_management.h>

Collaboration diagram for HF::Core::DeviceManagement::RegisterMessage:

Public Member Functions
	RegisterMessage (uint16_t emc=0x0000, HF::UID::UID _uid=HF::UID::UID())
	Device UID. 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
std::vector< Unit >	units
	Device EMC if applicable, 0 otherwise.
HF::UID::UID	uid
	Device units listing.

Static Public Attributes
static constexpr uint16_t	min_size
	Minimum pack/unpack required data size.

Detailed Description

Register command message.

Definition at line 256 of file device_management.h.

Constructor & Destructor Documentation

RegisterMessage()

HF::Core::DeviceManagement::RegisterMessage::RegisterMessage ( uint16_t  emc = 0x0000, HF::UID::UID  _uid = HF::UID::UID()  )

inline

Device UID.

Constructor.

Parameters

[in]	emc	device EMC (Electronic Manufacture Code)
[in]	_uid	device UID.

See also

HF::UID::UID_T

Definition at line 269 of file device_management.h.

                                                                              :
               emc(emc), uid(_uid)
            {}

Member Function Documentation

pack()

uint16_t HF::Core::DeviceManagement::RegisterMessage::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::DeviceManagement::RegisterMessage::size

(

)

const

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

unpack()

uint16_t HF::Core::DeviceManagement::RegisterMessage::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:

• device_management.h