HF::Core::DeviceInformation::FriendlyName::Unit Struct Reference

Data type representing a unit0's friendly name. More...

#include <device_information.h>

Collaboration diagram for HF::Core::DeviceInformation::FriendlyName::Unit:

Public Member Functions
uint16_t	size () const
	Number bytes needed to serialize the message. More...
uint16_t	pack (HF::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 HF::Common::ByteArray &array, uint16_t offset=0)
	Read a message from a ByteArray. More...

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

Detailed Description

Data type representing a unit0's friendly name.

Definition at line 163 of file device_information.h.

Member Function Documentation

pack()

uint16_t HF::Core::DeviceInformation::FriendlyName::Unit::pack	(	HF::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::DeviceInformation::FriendlyName::Unit::size

(

)

const

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

unpack()

uint16_t HF::Core::DeviceInformation::FriendlyName::Unit::unpack	(	const HF::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_information.h