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

Data type to contain the Friendly name attribute. More...

#include <device_information.h>

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

Data Structures
struct	Unit
	Data type representing a unit0's friendly name. More...

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...
float	changed (const FriendlyName &other) const
	This method is used to get the percentage of change that the attribute has in relation to the value present in other. More...
int	compare (const FriendlyName &other) const
	Compare this attribute with the given attribute in other. More...

Data Fields
std::vector< Unit >	units
	Device unit's friendly names.

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

Detailed Description

Data type to contain the Friendly name attribute.

Definition at line 158 of file device_information.h.

Member Function Documentation

changed()

float HF::Core::DeviceInformation::FriendlyName::changed ( const FriendlyName &  other ) const

inline

This method is used to get the percentage of change that the attribute has in relation to the value present in other.

Parameters

[in]

other

attribute holding a previous value.

Returns

float indicating the percentage of change.

Definition at line 199 of file device_information.h.

References UNUSED.

            {
               UNUSED(other);
               return 0.0;
            }

compare()

int HF::Core::DeviceInformation::FriendlyName::compare

(

const FriendlyName &

other

)

const

Compare this attribute with the given attribute in other.

This method should return < 0 if this attribute is less that, 0 if it is equal and > 0 if greater that the other attribute.

Parameters

[in]

other

attribute to compare to.

Return values

<0	if attribute less than other;
0	if attribute equal to other;
>0	if attribute greater than other.

pack()

uint16_t HF::Core::DeviceInformation::FriendlyName::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::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::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