HF::Common::SerializableHelper< T, typename > Struct Template Reference

Wrapper for classes that implement the Serializable concept. More...

#include <common.h>

Inheritance diagram for HF::Common::SerializableHelper< T, typename >:

Collaboration diagram for HF::Common::SerializableHelper< T, typename >:

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

Data Fields
T	data
	Data type instance wrapped.

Detailed Description

template<typename T, typename = void>
struct HF::Common::SerializableHelper< T, typename >

Wrapper for classes that implement the Serializable concept.

Template Parameters

T	data type to warp.

Warning

T should be POD (Plain Old Data)

Definition at line 496 of file inc/hanfun/common.h.

Member Function Documentation

pack()

template<typename T, typename = void>

uint16_t HF::Common::SerializableHelper< T, typename >::pack ( ByteArray &  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.

Implements HF::Common::Serializable.

Definition at line 514 of file inc/hanfun/common.h.

Referenced by HF::Core::SUOTA::UpgradeStatus::pack(), HF::Attributes::Attribute< bool >::pack(), HF::Attributes::Attribute< T, _Owner, EnableIf(IsParent(HF::Interface, _Owner))>::pack(), and HF::Common::SerializableHelper< std::string >::pack().

         {
            HF_SERIALIZABLE_CHECK(array, offset, size());
            return data.pack(array, offset);
         }

Here is the caller graph for this function:

size()

template<typename T, typename = void>

uint16_t HF::Common::SerializableHelper< T, typename >::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 509 of file inc/hanfun/common.h.

Referenced by HF::Common::SerializableHelper< bool >::pack(), HF::Common::SerializableHelper< T, EnableIf(IsClassPointer(T))>::pack(), HF::Common::SerializableHelper< Common::ByteArray >::pack(), HF::Common::SerializableHelper< std::vector< uint8_t > >::pack(), HF::Core::SUOTA::UpgradeStatus::size(), HF::Attributes::Attribute< bool >::size(), HF::Attributes::Attribute< T, _Owner, EnableIf(IsParent(HF::Interface, _Owner))>::size(), HF::Common::SerializableHelper< std::string >::size(), HF::Common::SerializableHelper< bool >::unpack(), HF::Common::SerializableHelper< T, EnableIf(IsClassPointer(T))>::unpack(), and HF::Common::SerializableHelper< std::vector< uint8_t > >::unpack().

         {
            return data.size();
         }

Here is the caller graph for this function:

unpack()

template<typename T, typename = void>

uint16_t HF::Common::SerializableHelper< T, typename >::unpack ( const ByteArray &  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.

Implements HF::Common::Serializable.

Definition at line 520 of file inc/hanfun/common.h.

Referenced by HF::Core::SUOTA::UpgradeStatus::unpack(), HF::Attributes::Attribute< bool >::unpack(), HF::Attributes::Attribute< T, _Owner, EnableIf(IsParent(HF::Interface, _Owner))>::unpack(), and HF::Common::SerializableHelper< std::string >::unpack().

         {
            HF_SERIALIZABLE_CHECK(array, offset, size());
            return data.unpack(array, offset);
         }

Here is the caller graph for this function:

---

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

• inc/hanfun/common.h