HF::UID::UID Class Reference

Wrapper around UID_T pointer's. More...

#include <uids.h>

Inheritance diagram for HF::UID::UID:

Collaboration diagram for HF::UID::UID:

Public Member Functions
	UID (UID_T *_uid, bool _owner=false)
	Constructor. More...
	UID (UID &&other)
	Move constructor. More...
	UID (const UID &other)
	Copy constructor. More...
uint8_t	type () const
	Type of the UID. More...
uint16_t	size () const
	Number bytes needed to serialize the message. More...
uint16_t	pack (Common::ByteArray &array, uint16_t offset) 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)
	Read a message from a ByteArray. More...
UID &	operator= (const UID &other)
	Copy assignment operator. More...
UID &	operator= (UID &&other)
	Move assignment operator. More...
UID &	operator= (UID_T *_uid)
	Use the given pointer as the pointer of the underlining UID to wrap around of. More...
int	compare (const UID &other) const
	Compare the current UID with the given UID. More...
int	compare (const UID_T &other) const
	Compare the current UID with the given UID. More...
UID_T const *	raw () const
	Get the underling wrapped UID_T pointer. More...
float	changed (const UID &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...
Public Member Functions inherited from HF::Common::Serializable
virtual	~Serializable ()
	Destructor.

Detailed Description

Wrapper around UID_T pointer's.

This class can either wrap an existing pointer (i.e. a pointer to an object it doesn't own) or wrap a pointer to an object that was created based on an existing object. In this case the clone object is owned by this class instance.

The destructor of this class will delete the object it owns.

Definition at line 531 of file uids.h.

Constructor & Destructor Documentation

UID() [1/3]

HF::UID::UID::UID ( UID_T *  _uid, bool  _owner = false  )

inline

Constructor.

Parameters

[in]	_uid	pointer to the UID being wrapped.
[in]	_owner	take ownership of the pointer being wrapped.

Definition at line 550 of file uids.h.

                                              :
            _raw(_uid), owner(_owner)
         {
            assert(_uid != nullptr);
         }

UID() [2/3]

HF::UID::UID::UID ( UID &&  other )

inline

Move constructor.

Parameters

[in]

other

UID to move from.

Definition at line 561 of file uids.h.

                         : _raw(other._raw), owner(other.owner)
         {
            other.owner = false;
         }

UID() [3/3]

HF::UID::UID::UID ( const UID &  other )

inline

Copy constructor.

The underling UID_T is cloned and this object takes ownership of it.

Parameters

[in]

other

UID to copy from.

Definition at line 573 of file uids.h.

                              : _raw(other._raw->clone()), owner(true)
         {}

Member Function Documentation

changed()

float HF::UID::UID::changed ( const UID &  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 710 of file uids.h.

References UNUSED.

         {
            UNUSED(other);
            return 0.0;
         }

compare() [1/2]

int HF::UID::UID::compare ( const UID &  other ) const

inline

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.

Definition at line 688 of file uids.h.

References HF::UID::UID_T::compare().

         {
            return _raw->compare(*(other._raw));
         }

Here is the call graph for this function:

compare() [2/2]

int HF::UID::UID::compare ( const UID_T &  other ) const

inline

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.

Definition at line 694 of file uids.h.

References HF::UID::UID_T::compare().

         {
            return _raw->compare(other);
         }

Here is the call graph for this function:

operator=() [1/3]

UID& HF::UID::UID::operator= ( const UID &  other )

inline

Copy assignment operator.

Parameters

[in]

other

UID to copy from.

Returns

a reference to this object.

Definition at line 627 of file uids.h.

References HF::Common::Cloneable< T >::clone().

         {
            // Ship if same object.
            if (this == &other)
            {
               return *this;
            }

            // Delete current wrapped object if owner.
            if (this->owner)
            {
               delete this->_raw;
            }

            // Clone wrapped UID_T and take ownership of the clone.
            this->_raw  = other._raw->clone();
            this->owner = true;

            return *this;
         }

Here is the call graph for this function:

operator=() [2/3]

UID& HF::UID::UID::operator= ( UID &&  other )

inline

Move assignment operator.

Parameters

[in]

other

UID to move from.

Returns

a reference to this object.

Definition at line 655 of file uids.h.

         {
            std::swap(this->_raw, other._raw);
            std::swap(this->owner, other.owner);

            return *this;
         }

operator=() [3/3]

UID& HF::UID::UID::operator= ( UID_T *  _uid )

inline

Use the given pointer as the pointer of the underlining UID to wrap around of.

Warning

the class takes ownership of the pointer and will delete the associated object when it is destructed.

Parameters

_uid	pointer to the UID_T object instance to manage.

Returns

reference to self.

Definition at line 674 of file uids.h.

         {
            if (owner)
            {
               delete this->_raw;
            }

            _raw  = _uid;
            owner = true;

            return *this;
         }

pack()

uint16_t HF::UID::UID::pack ( Common::ByteArray &  array, uint16_t  offset  ) 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.

Implements HF::Common::Serializable.

Definition at line 609 of file uids.h.

References HF::UID::UID_T::pack().

Referenced by hello_msg_t::pack().

         {
            return _raw->pack(array, offset);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

raw()

UID_T const* HF::UID::UID::raw ( ) const

inline

Get the underling wrapped UID_T pointer.

Returns

the underling wrapped UID_T pointer.

Definition at line 704 of file uids.h.

         {
            return _raw;
         }

size()

uint16_t HF::UID::UID::size ( ) const

inlinevirtual

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Implements HF::Common::Serializable.

Definition at line 604 of file uids.h.

References HF::UID::UID_T::size().

Referenced by hello_msg_t::size().

         {
            return _raw->size();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

type()

uint8_t HF::UID::UID::type ( ) const

inline

Type of the UID.

See also

HF::UID::Type.

Returns

type of the UID.

Definition at line 589 of file uids.h.

References HF::UID::UID_T::type().

         {
            return _raw->type();
         }

Here is the call graph for this function:

unpack()

uint16_t HF::UID::UID::unpack ( const Common::ByteArray &  array, uint16_t  offset  )

virtual

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.

Implements HF::Common::Serializable.

Referenced by hello_msg_t::unpack().

Here is the caller graph for this function:

---

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

• uids.h