HF::Attributes::UIDS Struct Reference

List of attributes UIDs. More...

#include <attributes.h>

Inherits std::vector< T >.

Collaboration diagram for HF::Attributes::UIDS:

Public Member Functions
	UIDS (std::initializer_list< uint8_t > uids)
	Constructor. More...
vector< uint8_t >::size_type	length () const
	Number of elements in the list. More...
uint16_t	unpack (const Common::ByteArray &array, uint16_t offset, uint8_t &count)
	Read a message from a ByteArray. More...

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

Detailed Description

List of attributes UIDs.

Definition at line 176 of file attributes.h.

Constructor & Destructor Documentation

UIDS()

HF::Attributes::UIDS::UIDS ( std::initializer_list< uint8_t >  uids )

inline

Constructor.

Parameters

[in]

uids

attributes UIDs list.

Definition at line 186 of file attributes.h.

                                                : vector<uint8_t>(uids)
         {}

Member Function Documentation

length()

vector<uint8_t>::size_type HF::Attributes::UIDS::length ( ) const

inline

Number of elements in the list.

Note

this is used as an alias to the underling method, std::vector<uint8_t>::size, as the size method signature is used to provide a Serializable type interface.

Returns

number of elements.

Definition at line 198 of file attributes.h.

         {
            return vector<uint8_t>::size();
         }

unpack()

uint16_t HF::Attributes::UIDS::unpack ( const Common::ByteArray &  array, uint16_t  offset, uint8_t &  count  )

inline

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.

Parameters

[out]

count

reference to a variable that will hold the count value read from the array.

Definition at line 244 of file attributes.h.

References HF_SERIALIZABLE_CHECK, min_size, and HF::Common::ByteArray::read().

         {
            HF_SERIALIZABLE_CHECK(array, offset, min_size);

            uint16_t start = offset;

            offset += array.read(offset, count);

            HF_SERIALIZABLE_CHECK(array, offset, count);

            vector<uint8_t>::reserve(count);

            for (uint8_t i = 0; i < count; i++)
            {
               uint8_t uid;
               offset += array.read(offset, uid);
               vector<uint8_t>::push_back(uid);
            }

            return offset - start;
         }

Here is the call graph for this function:

---

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

• attributes.h