EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
EMessageVector< T > Class Template Reference

A vector of fields. More...

#include <emsg.h>

Inheritance diagram for EMessageVector< T >:
EMessage

Public Member Functions

 EMessageVector ()
 Default constructor. More...
 
 EMessageVector (EMessageVector const &val)
 Copy constructor. More...
 
 ~EMessageVector ()
 Class destructor. More...
 
vector< T > & getList ()
 Retrieves the message vector. More...
 
Void vectorLength (ULong &length)
 Calcuates the packed length of the vector. More...
 
Void packVector (pVoid pBuffer, ULong &nOffset)
 Packs the vector. More...
 
Void unpackVector (pVoid Buffer, ULong &nOffset)
 Unpacks a vector. More...
 
- Public Member Functions inherited from EMessage
 EMessage ()
 Default constructor. More...
 
 ~EMessage ()
 Class destructor. More...
 
virtual Void getLength (ULong &length)
 Calculates the packed length of a message. More...
 
virtual Void serialize (pVoid pBuffer, ULong &nOffset)
 Serializes (packs) a message. More...
 
virtual Void unserialize (pVoid pBuffer, ULong &nOffset)
 Unserializes (unpacks) a message. More...
 
Void elementLength (Bool val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (Char val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (UChar val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (Short val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (UShort val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (Long val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (ULong val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (LongLong val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (ULongLong val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (Float val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (Double val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (cpStr val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (ETimer &val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void elementLength (ETime &val, ULong &length)
 Adds the length of a Bool value to the message length. More...
 
Void pack (Bool val, pVoid pBuffer, ULong &nOffset)
 Packs the Bool value. More...
 
Void pack (Char val, pVoid pBuffer, ULong &nOffset)
 Packs the Char value. More...
 
Void pack (UChar val, pVoid pBuffer, ULong &nOffset)
 Packs the UChar value. More...
 
Void pack (Short val, pVoid pBuffer, ULong &nOffset)
 Packs the Short value. More...
 
Void pack (UShort val, pVoid pBuffer, ULong &nOffset)
 Packs the UShort value. More...
 
Void pack (Long val, pVoid pBuffer, ULong &nOffset)
 Packs the Long value. More...
 
Void pack (ULong val, pVoid pBuffer, ULong &nOffset)
 Packs the ULong value. More...
 
Void pack (LongLong val, pVoid pBuffer, ULong &nOffset)
 Packs the LongLong value. More...
 
Void pack (ULongLong val, pVoid pBuffer, ULong &nOffset)
 Packs the ULongLong value. More...
 
Void pack (Float val, pVoid pBuffer, ULong &nOffset)
 Packs the Float value. More...
 
Void pack (Double val, pVoid pBuffer, ULong &nOffset)
 Packs the Double value. More...
 
Void pack (cpStr val, pVoid pBuffer, ULong &nOffset)
 Packs the NULL terminated string value. More...
 
Void pack (ETimer &val, pVoid pBuffer, ULong &nOffset)
 Packs the Timer value. More...
 
Void pack (ETime &val, pVoid pBuffer, ULong &nOffset)
 Packs the Time value. More...
 
Void pack (EString &val, pVoid pBuffer, ULong &nOffset)
 Packs the string value. More...
 
Void unpack (Bool &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Bool value. More...
 
Void unpack (Char &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Char value. More...
 
Void unpack (UChar &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a UChar value. More...
 
Void unpack (Short &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Short value. More...
 
Void unpack (UShort &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a UShort value. More...
 
Void unpack (Long &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Long value. More...
 
Void unpack (ULong &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a ULong value. More...
 
Void unpack (LongLong &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a LongLong value. More...
 
Void unpack (ULongLong &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a ULongLong value. More...
 
Void unpack (Float &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Float value. More...
 
Void unpack (Double &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Double value. More...
 
Void unpack (pStr val, pVoid pBuffer, ULong &nOffset)
 Unpacks a NULL terminated string value. More...
 
Void unpack (ETimer &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Timer value. More...
 
Void unpack (ETime &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a Time value. More...
 
Void unpack (EString &val, pVoid pBuffer, ULong &nOffset)
 Unpacks a string value. More...
 

Detailed Description

template<class T>
class EMessageVector< T >

A vector of fields.

Constructor & Destructor Documentation

◆ EMessageVector() [1/2]

template<class T >
EMessageVector< T >::EMessageVector ( )
inline

Default constructor.

◆ EMessageVector() [2/2]

template<class T >
EMessageVector< T >::EMessageVector ( EMessageVector< T > const &  val)
inline

Copy constructor.

Parameters
valthe EMessageVector to copy.

◆ ~EMessageVector()

template<class T >
EMessageVector< T >::~EMessageVector ( )
inline

Class destructor.

Member Function Documentation

◆ getList()

template<class T >
vector<T>& EMessageVector< T >::getList ( )
inline

Retrieves the message vector.

Returns
the message vector.

◆ packVector()

template<class T >
Void EMessageVector< T >::packVector ( pVoid  pBuffer,
ULong &  nOffset 
)
inline

Packs the vector.

Parameters
pBuffera pointer to the destination buffer.
nOffsetthe offset into the destination buffer to write the data to.

◆ unpackVector()

template<class T >
Void EMessageVector< T >::unpackVector ( pVoid  Buffer,
ULong &  nOffset 
)
inline

Unpacks a vector.

Parameters
Buffera pointer to the source buffer to unpack.
nOffsetthe offset into the source buffer to read the data from.

◆ vectorLength()

template<class T >
Void EMessageVector< T >::vectorLength ( ULong &  length)
inline

Calcuates the packed length of the vector.

Parameters
lengththe length value to update.

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