VR-Forces 4.0.4 Class Documentation
Classes | Functions
DtBufferSerialize Namespace Reference

This namespace contains a set of utility functions for encoding and decoding various data types to/from a byte array. More...

Classes

class  DtGroupEntityInfo

Functions

int getSize (const DtGroupEntityInfo &val)
char * encode (const DtGroupEntityInfo &val, char *buffer)
const char * decode (DtGroupEntityInfo &val, const char *buffer)
DT_DLL_vrfmsgs int getSize (const DtIfPlan *const &messagePtr)
DT_DLL_vrfmsgs char * encode (const DtIfPlan *const &messagePtr, char *buffer)
 Encodes the specified DtIfPlan into the specified character array.
DT_DLL_vrfmsgs const char * decode (DtIfPlan *&messagePtr, const char *buffer)
 Decodes the buffer into the DtIfPlan.
DT_DLL_vrfmsgs int getSize (const DtRwSpawnData &contentPtr)
DT_DLL_vrfmsgs char * encode (const DtRwSpawnData &adminContentPtr, char *buffer)
 Encodes the specified spawn data into the specified character array.
DT_DLL_vrfmsgs const char * decode (DtRwSpawnData &adminContentPtr, const char *buffer)
 Decodes the buffer into the spawn data.
DT_DLL_vrfmsgs int getSize (const DtSensorDataEntry &data)
 The number of bytes required to encode the value.
DT_DLL_vrfmsgs char * encode (const DtSensorDataEntry &data, char *buffer)
 Serializes the provided value data into buffer.
DT_DLL_vrfmsgs const char * decode (DtSensorDataEntry &data, const char *buffer)
 Decodes a value from buffer and places the result in data of the type specified by data.
DT_DLL_vrfmsgs int getSize (const DtSignalMessageHeader *const &messagePtr)
DT_DLL_vrfmsgs char * encode (const DtSignalMessageHeader *const &messagePtr, char *buffer)
 Encodes the specified DtSignalMessageHeader into the specified character array.
DT_DLL_vrfmsgs const char * decode (DtSignalMessageHeader *&messagePtr, const char *buffer)
 Decodes the buffer into the DtSignalMessageHeader using the DtVrfObjectMessage factory.
DT_DLL_vrfmsgs int getSize (const DtVrfObjectMessage *const &messagePtr)
DT_DLL_vrfmsgs char * encode (const DtVrfObjectMessage *const &messagePtr, char *buffer)
 Encodes the specified DtVrfObjectMessage into the specified character array.
DT_DLL_vrfmsgs const char * decode (DtVrfObjectMessage *&messagePtr, const char *buffer)
 Decodes the buffer into the DtVrfObjectMessage using the DtVrfObjectMessage factory.
DT_DLL_vrfplan int getSize (const DtPlan &contentPtr)
DT_DLL_vrfplan char * encode (const DtPlan &adminContentPtr, char *buffer)
 Encodes the specified plan into the specified character array.
DT_DLL_vrfplan const char * decode (DtPlan &adminContentPtr, const char *buffer)
 Decodes the buffer into the plan.
DT_DLL_vrfplan int getSize (const DtSimCommand *const &commandPtr)
DT_DLL_vrfplan char * encode (const DtSimCommand *const &commandPtr, char *buffer)
 Encodes the specified command into the specified character array.
DT_DLL_vrfplan const char * decode (DtSimCommand *&commandPtr, const char *buffer)
 Decodes the buffer into the command using the task factory.
DT_DLL_vrftasks int getSize (const DtAdminContent *const &contentPtr)
DT_DLL_vrftasks char * encode (const DtAdminContent *const &adminContentPtr, char *buffer)
 Encodes the specified admin content into the specified character array.
DT_DLL_vrftasks const char * decode (DtAdminContent *&adminContentPtr, const char *buffer)
 Decodes the buffer into the admin content using the admin content factory.
DT_DLL_vrftasks int getSize (const DtCurrentTaskData &val)
DT_DLL_vrftasks char * encode (const DtCurrentTaskData &val, char *buffer)
 Encodes the specified DtCurrentTaskData (including enclosed task) into the specified character array.
DT_DLL_vrftasks const char * decode (DtCurrentTaskData &val, const char *buffer)
 Decodes the buffer into the DtCurrentTaskData using the task factory.
DT_DLL_vrftasks int getSize (const DtSetDataRequest *const &setDataPtr)
DT_DLL_vrftasks char * encode (const DtSetDataRequest *const &setDataPtr, char *buffer)
 Encodes the specified set data request into the specified character array.
DT_DLL_vrftasks const char * decode (DtSetDataRequest *&setDataPtr, const char *buffer)
 Decodes the buffer into the set data request using the task factory.
DT_DLL_vrftasks int getSize (const DtSimTask *const &taskPtr)
DT_DLL_vrftasks char * encode (const DtSimTask *const &taskPtr, char *buffer)
 Encodes the specified task into the specified character array.
DT_DLL_vrftasks const char * decode (DtSimTask *&taskPtr, const char *buffer)
 Decodes the buffer into the task using the task factory.
DT_DLL_vrfutil int getSize (const DtAggregatedResourceList &val)
DT_DLL_vrfutil char * encode (const DtAggregatedResourceList &val, char *buffer)
 Encodes the list into the buffer.
DT_DLL_vrfutil const char * decode (DtAggregatedResourceList &val, const char *buffer)
DT_DLL_vrfutil int getSize (const DtSimInterfaceContent *const &contentPtr)
DT_DLL_vrfutil char * encode (const DtSimInterfaceContent *const &adminContentPtr, char *buffer)
 Encodes the specified interface content into the specified character array.
DT_DLL_vrfutil const char * decode (DtSimInterfaceContent *&interfaceContentPtr, const char *buffer)
 Decodes the buffer into the admin content using the interface content factory.
DT_DLL_vrfutil int getSize (const DtRailSegment &data)
 The number of bytes required to encode the value.
DT_DLL_vrfutil char * encode (const DtRailSegment &data, char *buffer)
 Serializes the provided value data into buffer.
DT_DLL_vrfutil const char * decode (DtRailSegment &data, const char *buffer)
 Decodes a value from buffer and places the result in data of the type specified by data.
DT_DLL_vrfutil int getSize (const DtRwAggregateState &val)
 The number of bytes required to encode the value.
DT_DLL_vrfutil char * encode (const DtRwAggregateState &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil const char * decode (DtRwAggregateState &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil int getSize (const DtRwForceType &val)
 The number of bytes required to encode the value.
DT_DLL_vrfutil char * encode (const DtRwForceType &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil const char * decode (DtRwForceType &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil int getSize (const DtRwFormationType &val)
DT_DLL_vrfutil char * encode (const DtRwFormationType &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil const char * decode (DtRwFormationType &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil char * encode (const DtRwKeyValueList &val, char *buffer)
DT_DLL_vrfutil const char * decode (DtRwKeyValueList &val, const char *buffer)
DT_DLL_vrfutil int getSize (const DtRwKeyValueList &val)
DT_DLL_vrfutil int getSize (const DtRwObjectTypeInfo &contentPtr)
DT_DLL_vrfutil char * encode (const DtRwObjectTypeInfo &adminContentPtr, char *buffer)
 Encodes the specified spawn data into the specified character array.
DT_DLL_vrfutil const char * decode (DtRwObjectTypeInfo &adminContentPtr, const char *buffer)
 Decodes the buffer into the spawn data.
DT_DLL_vrfutil int getSize (const DtRwReal &val)
DT_DLL_vrfutil char * encode (const DtRwReal &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil const char * decode (DtRwReal &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil int getSize (const DtRwSensorContactInfo &data)
 The number of bytes required to encode the value.
DT_DLL_vrfutil char * encode (const DtRwSensorContactInfo &data, char *buffer)
 Serializes the provided value data into buffer.
DT_DLL_vrfutil const char * decode (DtRwSensorContactInfo &data, const char *buffer)
 Decodes a value from buffer and places the result in data of the type specified by data.
template<typename T >
int getSize (const DtRwTemplatedListPtr< T > &val)
template<typename T >
char * encode (const DtRwTemplatedListPtr< T > &val, char *buffer)
 Encodes the list into the buffer.
template<typename T >
const char * decode (DtRwTemplatedListPtr< T > &val, const char *buffer)
 Decodes a list from buffer.
DT_DLL_vrfutil int getSize (const DtRwUnsigned &val)
DT_DLL_vrfutil char * encode (const DtRwUnsigned &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil const char * decode (DtRwUnsigned &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil int getSize (const DtSubordinateAggregateEntry &val)
DT_DLL_vrfutil char * encode (const DtSubordinateAggregateEntry &data, char *buffer)
DT_DLL_vrfutil const char * decode (DtSubordinateAggregateEntry &data, const char *buffer)
DT_DLL_vrfutil int getSize (const DtSubordinateEntry &val)
DT_DLL_vrfutil char * encode (const DtSubordinateEntry &data, char *buffer)
DT_DLL_vrfutil const char * decode (DtSubordinateEntry &data, const char *buffer)
DT_DLL_vrfutil int getSize (const DtSubordinateObjectsList &val)
DT_DLL_vrfutil char * encode (const DtSubordinateObjectsList &val, char *buffer)
 Encodes the list into the buffer.
DT_DLL_vrfutil const char * decode (DtSubordinateObjectsList &val, const char *buffer)
DT_DLL_vrfutil char * encode (const DtFilename &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtString &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const std::string &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const char *val, unsigned nSize, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const int &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtInt16 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtU8 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtU16 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtU32 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtU64 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtFloat32 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtFloat64 &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtVector &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtTaitBryan &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const bool &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtObjectType &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const std::vector< char > &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtRwBoolean &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtEntityType &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtEntityIdentifier &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtSimulationAddress &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtAppearance &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtForceType &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtInetAddr &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtRwInt &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtRwObjectType &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const DtRwStringList &val, char *buffer)
 Serializes the provided value val into buffer.
template<typename T >
char * encode (const std::vector< T > &val, char *buffer)
 Serializes the provided value val into buffer.
template<typename T >
char * encode (const std::list< T > &val, char *buffer)
 Serializes the provided value val into buffer.
template<typename T1 , typename T2 >
char * encode (const std::map< T1, T2 > &val, char *buffer)
 Serializes the provided value val into buffer.
template<typename T1 , typename T2 >
char * encode (const std::pair< T1, T2 > &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil char * encode (const std::vector< bool > &val, char *buffer)
 Serializes the provided value val into buffer.
DT_DLL_vrfutil const char * decode (DtString &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (std::string &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtFilename &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (int &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtU8 &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtU16 &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtU32 &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtU64 &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtFloat32 &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtFloat64 &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtVector &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtTaitBryan &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (bool &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtObjectType &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (std::vector< char > &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtRwBoolean &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtEntityType &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtEntityIdentifier &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtSimulationAddress &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtAppearance &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtForceType &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtInetAddr &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtRwInt &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtRwObjectType &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (DtRwStringList &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
template<typename T >
const char * decode (std::vector< T > &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
template<typename T >
const char * decode (std::list< T > &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
template<typename T1 , typename T2 >
const char * decode (std::map< T1, T2 > &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
template<typename T1 , typename T2 >
const char * decode (std::pair< T1, T2 > &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil const char * decode (std::vector< bool > &val, const char *buffer)
 Decodes a value from buffer and places the result in val of the type specified by val.
DT_DLL_vrfutil int getSize (const DtString &val)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const std::string &val)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtFilename &val)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtVector &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const int &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtU8 &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtU16 &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtU32 &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtU64 &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtFloat32 &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtFloat64 &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const bool &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtObjectType &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtTaitBryan &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const std::vector< char > &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtRwBoolean &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtEntityType &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtEntityIdentifier &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtSimulationAddress &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtAppearance &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtForceType &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtInetAddr &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtRwInt &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtRwObjectType &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const DtRwStringList &v)
 The number of bytes required to encode the value.
template<typename T >
int getSize (const std::vector< T > &v)
 The number of bytes required to encode the value.
template<typename T >
int getSize (const std::list< T > &v)
 The number of bytes required to encode the value.
template<typename T1 , typename T2 >
int getSize (const std::map< T1, T2 > &v)
 The number of bytes required to encode the value.
template<typename T1 , typename T2 >
int getSize (const std::pair< T1, T2 > &v)
 The number of bytes required to encode the value.
DT_DLL_vrfutil int getSize (const std::vector< bool > &v)
 The number of bytes required to encode the value.

Detailed Description

This namespace contains a set of utility functions for encoding and decoding various data types to/from a byte array.

Each data type has a encode(), decode(), and getSize() method defined. Use of the templated versions require that any types passed into the template have these same methods defined.


Function Documentation

int DtBufferSerialize::getSize ( const DtGroupEntityInfo &  val)

Referenced by getSize().

char* DtBufferSerialize::encode ( const DtGroupEntityInfo &  val,
char *  buffer 
)

Referenced by encode().

const char* DtBufferSerialize::decode ( DtGroupEntityInfo &  val,
const char *  buffer 
)

Referenced by decode().

DT_DLL_vrfmsgs int DtBufferSerialize::getSize ( const DtIfPlan *const &  messagePtr)
Returns:
The number of bytes required to encode the specified DtIfPlan.
Note:
Passing in a null task pointer is valid (will return size of 0).
DT_DLL_vrfmsgs char* DtBufferSerialize::encode ( const DtIfPlan *const &  messagePtr,
char *  buffer 
)

Encodes the specified DtIfPlan into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null DtIfPlan pointer is valid (nothing will be encoded)
DT_DLL_vrfmsgs const char* DtBufferSerialize::decode ( DtIfPlan *&  messagePtr,
const char *  buffer 
)

Decodes the buffer into the DtIfPlan.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null DtVrfObjectMessage pointer is valid
Returns:
The number of bytes required to encode the specified spawn data.
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfmsgs char* DtBufferSerialize::encode ( const DtRwSpawnData adminContentPtr,
char *  buffer 
)

Encodes the specified spawn data into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfmsgs const char* DtBufferSerialize::decode ( DtRwSpawnData adminContentPtr,
const char *  buffer 
)

Decodes the buffer into the spawn data.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().

The number of bytes required to encode the value.

DT_DLL_vrfmsgs char* DtBufferSerialize::encode ( const DtSensorDataEntry data,
char *  buffer 
)

Serializes the provided value data into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfmsgs const char* DtBufferSerialize::decode ( DtSensorDataEntry data,
const char *  buffer 
)

Decodes a value from buffer and places the result in data of the type specified by data.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Returns:
The number of bytes required to encode the specified DtSignalMessageHeader.
Note:
Passing in a null task pointer is valid.
DT_DLL_vrfmsgs char* DtBufferSerialize::encode ( const DtSignalMessageHeader *const &  messagePtr,
char *  buffer 
)

Encodes the specified DtSignalMessageHeader into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null DtSignalMessageHeader pointer is valid.
DT_DLL_vrfmsgs const char* DtBufferSerialize::decode ( DtSignalMessageHeader *&  messagePtr,
const char *  buffer 
)

Decodes the buffer into the DtSignalMessageHeader using the DtVrfObjectMessage factory.

messagePtr will be deleted and reallocated by this method. The type of the DtVrfObjectMessage created will be determined by the message type specified in the buffer.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null DtSignalMessageHeader pointer is valid.
DT_DLL_vrfmsgs int DtBufferSerialize::getSize ( const DtVrfObjectMessage *const &  messagePtr)
Returns:
The number of bytes required to encode the specified DtVrfObjectMessage.
Note:
Passing in a null task pointer is valid.
DT_DLL_vrfmsgs char* DtBufferSerialize::encode ( const DtVrfObjectMessage *const &  messagePtr,
char *  buffer 
)

Encodes the specified DtVrfObjectMessage into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null DtVrfObjectMessage pointer is valid.
DT_DLL_vrfmsgs const char* DtBufferSerialize::decode ( DtVrfObjectMessage *&  messagePtr,
const char *  buffer 
)

Decodes the buffer into the DtVrfObjectMessage using the DtVrfObjectMessage factory.

messagePtr will be deleted and reallocated by this method. The type of the task created will be determined by the task type specified in the buffer. If no DtVrfObjectMessage could be created from the buffer, messagePtr will be null after the function call.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null DtVrfObjectMessage pointer is valid.
DT_DLL_vrfplan int DtBufferSerialize::getSize ( const DtPlan contentPtr)
Returns:
The number of bytes required to encode the specified plan.
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfplan char* DtBufferSerialize::encode ( const DtPlan adminContentPtr,
char *  buffer 
)

Encodes the specified plan into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfplan const char* DtBufferSerialize::decode ( DtPlan adminContentPtr,
const char *  buffer 
)

Decodes the buffer into the plan.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode(). DT_DLL_vrfutil const char decode(DtPlan& adminContentPtr, const char *buffer);
DT_DLL_vrfplan int DtBufferSerialize::getSize ( const DtSimCommand *const &  commandPtr)
Returns:
The number of bytes required to encode the specified command.
Note:
Passing in a null command pointer is valid.
DT_DLL_vrfplan char* DtBufferSerialize::encode ( const DtSimCommand *const &  commandPtr,
char *  buffer 
)

Encodes the specified command into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null command pointer is valid.
DT_DLL_vrfplan const char* DtBufferSerialize::decode ( DtSimCommand *&  commandPtr,
const char *  buffer 
)

Decodes the buffer into the command using the task factory.

commandPtr will be deleted and reallocated by this method. The type of the command created will be determined by the command type specified in the buffer. If no command could be created from the buffer, commandPtr will be null after the function call.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null command pointer is valid.
DT_DLL_vrftasks int DtBufferSerialize::getSize ( const DtAdminContent *const &  contentPtr)
Returns:
The number of bytes required to encode the specified admin content.
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrftasks char* DtBufferSerialize::encode ( const DtAdminContent *const &  adminContentPtr,
char *  buffer 
)

Encodes the specified admin content into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrftasks const char* DtBufferSerialize::decode ( DtAdminContent *&  adminContentPtr,
const char *  buffer 
)

Decodes the buffer into the admin content using the admin content factory.

adminContentPtr will be deleted and reallocated by this method. The type of the task created will be determined by the task type specified in the buffer. If no task could be created from the buffer, taskPtr will be null after the function call.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null set data request pointer is valid.
Returns:
The number of bytes requires to serialize the specified DtCurrentTaskData.
DT_DLL_vrftasks char* DtBufferSerialize::encode ( const DtCurrentTaskData val,
char *  buffer 
)

Encodes the specified DtCurrentTaskData (including enclosed task) into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrftasks const char* DtBufferSerialize::decode ( DtCurrentTaskData val,
const char *  buffer 
)

Decodes the buffer into the DtCurrentTaskData using the task factory.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
DT_DLL_vrftasks int DtBufferSerialize::getSize ( const DtSetDataRequest *const &  setDataPtr)
Returns:
The number of bytes required to encode the specified set data request.
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrftasks char* DtBufferSerialize::encode ( const DtSetDataRequest *const &  setDataPtr,
char *  buffer 
)

Encodes the specified set data request into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrftasks const char* DtBufferSerialize::decode ( DtSetDataRequest *&  setDataPtr,
const char *  buffer 
)

Decodes the buffer into the set data request using the task factory.

taskPtr will be deleted and reallocated by this method. The type of the task created will be determined by the task type specified in the buffer. If no task could be created from the buffer, taskPtr will be null after the function call.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrftasks int DtBufferSerialize::getSize ( const DtSimTask *const &  taskPtr)
Returns:
The number of bytes required to encode the specified task.
Note:
Passing in a null task pointer is valid.
DT_DLL_vrftasks char* DtBufferSerialize::encode ( const DtSimTask *const &  taskPtr,
char *  buffer 
)

Encodes the specified task into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null task pointer is valid.
DT_DLL_vrftasks const char* DtBufferSerialize::decode ( DtSimTask *&  taskPtr,
const char *  buffer 
)

Decodes the buffer into the task using the task factory.

taskPtr will be deleted and reallocated by this method. The type of the task created will be determined by the task type specified in the buffer. If no task could be created from the buffer, taskPtr will be null after the function call.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null task pointer is valid.
Returns:
The number of bytes required to serialize the list.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtAggregatedResourceList val,
char *  buffer 
)

Encodes the list into the buffer.

No length checking is done, buffer must be at least getSize() long.

DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtAggregatedResourceList val,
const char *  buffer 
)
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtFilename &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtString val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const std::string &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const char *  val,
unsigned  nSize,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const int &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtInt16 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtU8 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtU16 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtU32 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtU64 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtFloat32 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtFloat64 &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtVector val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtTaitBryan &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const bool val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtObjectType val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const std::vector< char > &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwBoolean val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtEntityType &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtEntityIdentifier &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtSimulationAddress &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtAppearance &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtForceType &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtInetAddr &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwInt val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwObjectType val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwStringList val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
template<typename T >
char* DtBufferSerialize::encode ( const std::vector< T > &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
template<typename T >
char* DtBufferSerialize::encode ( const std::list< T > &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
template<typename T1 , typename T2 >
char* DtBufferSerialize::encode ( const std::map< T1, T2 > &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
template<typename T1 , typename T2 >
char* DtBufferSerialize::encode ( const std::pair< T1, T2 > &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const std::vector< bool > &  val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
When argument is a template, the templated type passed in must have an encode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtString val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( std::string &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtFilename &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( int &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtU8 &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtU16 &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtU32 &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtU64 &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtFloat32 &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtFloat64 &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtVector val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtTaitBryan &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( bool val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtObjectType val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( std::vector< char > &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwBoolean val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtEntityType &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtEntityIdentifier &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtSimulationAddress &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtAppearance &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtForceType &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtInetAddr &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwInt val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwObjectType val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwStringList val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
template<typename T >
const char* DtBufferSerialize::decode ( std::vector< T > &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
template<typename T >
const char* DtBufferSerialize::decode ( std::list< T > &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
template<typename T1 , typename T2 >
const char* DtBufferSerialize::decode ( std::map< T1, T2 > &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
template<typename T1 , typename T2 >
const char* DtBufferSerialize::decode ( std::pair< T1, T2 > &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( std::vector< bool > &  val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
When argument is a template, the templated type passed in must have a decode() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const std::string &  val)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtFilename &  val)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtU8 &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtU16 &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtU32 &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtU64 &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtFloat32 &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtFloat64 &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtTaitBryan &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const std::vector< char > &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtEntityType &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtEntityIdentifier &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtSimulationAddress &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtAppearance &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtForceType &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const DtInetAddr &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
template<typename T >
int DtBufferSerialize::getSize ( const std::vector< T > &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
template<typename T >
int DtBufferSerialize::getSize ( const std::list< T > &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
template<typename T1 , typename T2 >
int DtBufferSerialize::getSize ( const std::map< T1, T2 > &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
template<typename T1 , typename T2 >
int DtBufferSerialize::getSize ( const std::pair< T1, T2 > &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
DT_DLL_vrfutil int DtBufferSerialize::getSize ( const std::vector< bool > &  v)

The number of bytes required to encode the value.

Note:
When argument is a template, the templated type passed in must have a getSize() method defined.
Returns:
The number of bytes required to encode the specified interface content.
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtSimInterfaceContent *const &  adminContentPtr,
char *  buffer 
)

Encodes the specified interface content into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtSimInterfaceContent *&  interfaceContentPtr,
const char *  buffer 
)

Decodes the buffer into the admin content using the interface content factory.

interfaceContentPtr will be deleted and reallocated by this method. The type of the content created will be determined by the content type specified in the buffer. If no task could be created from the buffer, contentPtr will be null after the function call.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Note:
Passing in a null set data request pointer is valid.

The number of bytes required to encode the value.

DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRailSegment data,
char *  buffer 
)

Serializes the provided value data into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRailSegment data,
const char *  buffer 
)

Decodes a value from buffer and places the result in data of the type specified by data.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().

The number of bytes required to encode the value.

DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwAggregateState val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwAggregateState val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().

The number of bytes required to encode the value.

DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwForceType val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwForceType val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Returns:
The number of bytes required to encode the value.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwFormationType val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Note:
The valueSpecified flag is also encoded.
Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwFormationType val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Note:
The valueSpecified flag is also decoded.
Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwKeyValueList val,
char *  buffer 
)
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwKeyValueList val,
const char *  buffer 
)
Returns:
The number of bytes required to encode the specified spawn data.
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwObjectTypeInfo adminContentPtr,
char *  buffer 
)

Encodes the specified spawn data into the specified character array.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
Note:
Passing in a null set data request pointer is valid.
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwObjectTypeInfo adminContentPtr,
const char *  buffer 
)

Decodes the buffer into the spawn data.

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
Returns:
The number of bytes required to encode the value.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwReal val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Note:
The valueSpecified flag is also encoded.
Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwReal val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Note:
The valueSpecified flag is also decoded.
Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().

The number of bytes required to encode the value.

DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwSensorContactInfo data,
char *  buffer 
)

Serializes the provided value data into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwSensorContactInfo data,
const char *  buffer 
)

Decodes a value from buffer and places the result in data of the type specified by data.

Buffer must contain a value created by the corresponding call to encode().

Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
template<typename T >
int DtBufferSerialize::getSize ( const DtRwTemplatedListPtr< T > &  val)
Returns:
The number of bytes required to serialize the list.
Note:
Type T must have a DtBufferSerialize::getSize() method.

References getSize().

template<typename T >
char * DtBufferSerialize::encode ( const DtRwTemplatedListPtr< T > &  val,
char *  buffer 
)

Encodes the list into the buffer.

No length checking is done, buffer must be at least getSize() long.

Note:
Type T must have a DtBufferSerialize::encode() method.

References encode().

template<typename T >
const char * DtBufferSerialize::decode ( DtRwTemplatedListPtr< T > &  val,
const char *  buffer 
)

Decodes a list from buffer.

Note:
Type T must have a DtBufferSerialize::decode() method.
The names of the items will not be preserved. They will all have the RW name of "item" once decoded.

References DtRwList::addToEnd(), decode(), DtReaderWriter::registry(), and DtRwTemplatedListPtr< T >::removeAndDeleteAll().

Returns:
The number of bytes required to encode the value.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtRwUnsigned val,
char *  buffer 
)

Serializes the provided value val into buffer.

buffer must have at least the number of bytes returned by getSize() for the same parameter. No length checking is done on buffer.

Note:
The valueSpecified flag is also encoded.
Returns:
The pointer for buffer following the serialization. This value may be passed into the next call to encode().
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtRwUnsigned val,
const char *  buffer 
)

Decodes a value from buffer and places the result in val of the type specified by val.

Buffer must contain a value created by the corresponding call to encode().

Note:
The valueSpecified flag is also decoded.
Returns:
The pointer to buffer after the decode. This is appropriate to pass into the next call of decode().
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtSubordinateAggregateEntry data,
char *  buffer 
)
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtSubordinateAggregateEntry data,
const char *  buffer 
)
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtSubordinateEntry data,
char *  buffer 
)
DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtSubordinateEntry data,
const char *  buffer 
)
Returns:
The number of bytes required to serialize the list.
DT_DLL_vrfutil char* DtBufferSerialize::encode ( const DtSubordinateObjectsList val,
char *  buffer 
)

Encodes the list into the buffer.

No length checking is done, buffer must be at least getSize() long.

DT_DLL_vrfutil const char* DtBufferSerialize::decode ( DtSubordinateObjectsList val,
const char *  buffer 
)

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)