#include <device_management.h>

Collaboration diagram for HF::Core::DeviceManagement::Device:

Public Member Functions
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...

bool	operator== (Device &other)
	Equals operator.

bool	operator!= (Device &other)
	Not equals operator.

Data Fields
uint16_t	address
	Device Address. More...

std::vector< Unit >	units
	Unit list of the interface. More...

uint16_t	emc
	Device EMC if applicable, 0 otherwise. More...

HF::UID::UID	uid
	Device UID. More...

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

Detailed Description

Device Entry.

Definition at line 170 of file device_management.h.

Member Function Documentation

◆ pack()

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

◆ address

uint16_t HF::Core::DeviceManagement::Device::address

Device Address.

Definition at line 172 of file device_management.h.

Referenced by DeviceManagement::Server::available(), and operator==().

◆ emc

uint16_t HF::Core::DeviceManagement::Device::emc

Device EMC if applicable, 0 otherwise.

Definition at line 175 of file device_management.h.

◆ uid

HF::UID::UID HF::Core::DeviceManagement::Device::uid

Device UID.

Definition at line 177 of file device_management.h.

Referenced by operator==().

◆ units

std::vector<Unit> HF::Core::DeviceManagement::Device::units

Unit list of the interface.

Definition at line 173 of file device_management.h.

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

device_management.h

Public Member Functions

Data Fields

Static Public Attributes