HF::UID::ByteArray< _Class, _size, _type > Class Template Reference

Helper template parent class for all UIDs based on fixed number of bytes. More...

#include <uids.h>

Inheritance diagram for HF::UID::ByteArray< _Class, _size, _type >:

Collaboration diagram for HF::UID::ByteArray< _Class, _size, _type >:

Public Member Functions
	ByteArray (uint8_t _value[_size])
	Constructor. More...
	ByteArray (uint8_t _value)
	Constructor. 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...
int	compare (const UID_T &other) const
	Compare the current UID with the given UID. More...
uint8_t const &	operator[] (uint16_t index) const
	Get byte at the given index. More...
uint8_t &	operator[] (uint16_t index)
	Get byte at the given index. More...
uint8_t const &	at (uint16_t index) const
	Get byte at the given index, asserting that the index is within the correct range. More...
uint8_t &	at (uint16_t index)
	Get byte at the given index, asserting that the index is within the correct range. More...
void	fill (uint8_t byte)
	Fill the underlining byte array with the given value. More...
void	clear ()
	Fill the underlining byte array with 0.
Public Member Functions inherited from HF::UID::Abstract< _type >
uint8_t	type () const
	Type of the UID. More...
Public Member Functions inherited from HF::Common::Serializable
virtual	~Serializable ()
	Destructor.
Public Member Functions inherited from HF::Common::Cloneable< UID_T >
virtual UID_T *	clone () const=0
	Create a clone object of the object where this method is being called. More...

Static Public Member Functions
static uint16_t	length ()
	Return the number of bytes in the underlining byte array. More...

Static Public Attributes
static constexpr uint16_t	min_size = UID_T::min_size + _size
	Minimum pack/unpack required data size.
Static Public Attributes inherited from HF::UID::UID_T
static constexpr uint16_t	min_size
	Minimum pack/unpack required data size.

Detailed Description

template<typename _Class, uint8_t _size, uint8_t _type>
class HF::UID::ByteArray< _Class, _size, _type >

Helper template parent class for all UIDs based on fixed number of bytes.

Template Parameters

_Class	child class being created.
_size	number of bytes in the UID.
_type	UID type value.

Definition at line 192 of file uids.h.

Constructor & Destructor Documentation

ByteArray() [1/2]

template<typename _Class, uint8_t _size, uint8_t _type>

HF::UID::ByteArray< _Class, _size, _type >::ByteArray ( uint8_t  _value[_size] )

inline

Constructor.

Parameters

[in]

_value

initial value for UID.

Definition at line 207 of file uids.h.

                                         : Abstract<_type>()
         {
            memcpy(value, _value, _size * sizeof(uint8_t));
         }

ByteArray() [2/2]

template<typename _Class, uint8_t _size, uint8_t _type>

HF::UID::ByteArray< _Class, _size, _type >::ByteArray ( uint8_t  _value )

inline

Constructor.

Parameters

[in]

_value

initial fill value for UID.

Definition at line 217 of file uids.h.

                                  : Abstract<_type>()
         {
            memset(value, _value, _size * sizeof(uint8_t));
         }

Member Function Documentation

at() [1/2]

template<typename _Class, uint8_t _size, uint8_t _type>

uint8_t const& HF::UID::ByteArray< _Class, _size, _type >::at ( uint16_t  index ) const

inline

Get byte at the given index, asserting that the index is within the correct range.

Warning

the assert is only in effect if NDEBUG is not defined.

Parameters

[in]

index

index to get the byte from.

Returns

the byte at the given index.

Definition at line 320 of file uids.h.

         {
            assert(index < _size);
            return value[index];
         }

at() [2/2]

template<typename _Class, uint8_t _size, uint8_t _type>

uint8_t& HF::UID::ByteArray< _Class, _size, _type >::at ( uint16_t  index )

inline

Get byte at the given index, asserting that the index is within the correct range.

Warning

the assert is only in effect if NDEBUG is not defined.

Parameters

[in]

index

index to get the byte from.

Returns

the byte at the given index.

Definition at line 336 of file uids.h.

         {
            assert(index < _size);
            return value[index];
         }

compare()

template<typename _Class, uint8_t _size, uint8_t _type>

int HF::UID::ByteArray< _Class, _size, _type >::compare ( const UID_T &  other ) const

inlinevirtual

Compare the current UID with the given UID.

This function returns a value less that 0 if the current UID object order is lower that the given UID, 0 if the UIDs represent the same entity and a value greater that 0 if current UID object is above the given UID.

Parameters

[in]

other

a pointer to a UID object to compare to.

Return values

<0	the current UID is lower that the given UID.
0	the current UID is the same as given UID.
>0	the current UID is greater that the given UID.

Reimplemented from HF::UID::UID_T.

Definition at line 274 of file uids.h.

         {
            int res = Abstract<_type>::compare(other);

            return (res ==
                    0 ? memcmp(value, ((_Class *) &other)->value, sizeof(value)) : res);
         }

fill()

template<typename _Class, uint8_t _size, uint8_t _type>

void HF::UID::ByteArray< _Class, _size, _type >::fill ( uint8_t  byte )

inline

Fill the underlining byte array with the given value.

Parameters

byte	the value to be used to fill the byte array.

Definition at line 351 of file uids.h.

         {
            memset(value, byte, sizeof(value));
         }

length()

template<typename _Class, uint8_t _size, uint8_t _type>

static uint16_t HF::UID::ByteArray< _Class, _size, _type >::length ( )

inlinestatic

Return the number of bytes in the underlining byte array.

Returns

number of bytes in the underlining byte array.

Definition at line 369 of file uids.h.

         {
            return _size;
         }

operator[]() [1/2]

template<typename _Class, uint8_t _size, uint8_t _type>

uint8_t const& HF::UID::ByteArray< _Class, _size, _type >::operator[] ( uint16_t  index ) const

inline

Get byte at the given index.

Parameters

[in]

index

index to get the byte from.

Returns

the byte at the given index.

Definition at line 293 of file uids.h.

         {
            return value[index];
         }

operator[]() [2/2]

template<typename _Class, uint8_t _size, uint8_t _type>

uint8_t& HF::UID::ByteArray< _Class, _size, _type >::operator[] ( uint16_t  index )

inline

Get byte at the given index.

Parameters

[in]

index

index to get the byte from.

Returns

the byte at the given index.

Definition at line 305 of file uids.h.

         {
            return value[index];
         }

pack()

template<typename _Class, uint8_t _size, uint8_t _type>

uint16_t HF::UID::ByteArray< _Class, _size, _type >::pack ( Common::ByteArray< _Class, _size, _type > &  array, uint16_t  offset = 0  ) const

inlinevirtual

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.

Reimplemented from HF::UID::UID_T.

Definition at line 230 of file uids.h.

         {
            HF_SERIALIZABLE_CHECK(array, offset, min_size);

            offset += Abstract<_type>::pack(array, offset);

            offset += array.write(offset, (uint8_t) sizeof(value));

            for (uint8_t i = 0; i < sizeof(value); i++)
            {
               offset += array.write(offset, value[i]);
            }

            return min_size;
         }

size()

template<typename _Class, uint8_t _size, uint8_t _type>

uint16_t HF::UID::ByteArray< _Class, _size, _type >::size ( ) const

inlinevirtual

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Reimplemented from HF::UID::UID_T.

Definition at line 225 of file uids.h.

Referenced by HF::UID::ByteArray< MAC, 6, MAC_UID >::unpack().

         {
            return min_size;
         }

Here is the caller graph for this function:

unpack()

template<typename _Class, uint8_t _size, uint8_t _type>

uint16_t HF::UID::ByteArray< _Class, _size, _type >::unpack ( const Common::ByteArray< _Class, _size, _type > &  array, uint16_t  offset = 0  )

inlinevirtual

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.

Reimplemented from HF::UID::UID_T.

Definition at line 246 of file uids.h.

         {
            HF_SERIALIZABLE_CHECK(array, offset, min_size);

            offset += Abstract<_type>::unpack(array, offset);

            uint8_t size;
            offset += array.read(offset, size);

            assert(size == sizeof(value));

            if (size != sizeof(value))
            {
               return 0;
            }

            for (uint8_t i = 0; i < size; i++)
            {
               offset += array.read(offset, value[i]);
            }

            return min_size;
         }

---

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

• uids.h