DtCommentDecoder Class Reference

Instances of DtCommentDecoder are used to decode Comment Interactions from the network. More...

Inheritance diagram for DtCommentDecoder:

Collaboration diagram for DtCommentDecoder:

Public Member Functions
	DtCommentDecoder (DtExerciseConn *exConn, DtInterClassDesc *classDesc)
	constructor
virtual	~DtCommentDecoder ()
	destructor
	DtCommentDecoder (const DtCommentDecoder &orig)
	copy constructor
DtCommentDecoder &	operator= (const DtCommentDecoder &orig)
	assignment operator
Public Member Functions inherited from DtInteractionWithDataDecoder
	DtInteractionWithDataDecoder (DtExerciseConn *exConn, DtInterClassDesc *classDesc, bool containsFixedDatums=true)
	constructor
virtual	~DtInteractionWithDataDecoder ()
	destructor
	DtInteractionWithDataDecoder (const DtInteractionWithDataDecoder &orig)
	copy constructor
DtInteractionWithDataDecoder &	operator= (const DtInteractionWithDataDecoder &orig)
	assignment operator
Public Member Functions inherited from DtInteractionDecoder
	DtInteractionDecoder (DtExerciseConn *exConn, DtInterClassDesc *classDesc)
	constructor
virtual	~DtInteractionDecoder ()
	destructor
DtParameterDecoder	addDecoder (RTI::ParameterHandle handle, DtParameterDecoder proc)
	Add/Remove a decoding function for the parameter specified by handle.
DtParameterDecoder	addDecoder (char *name, DtParameterDecoder proc)
	Add/Remove a decoding function for the parameter specified by name.
virtual DtParameterDecoder	decoder (RTI::ParameterHandle handle) const
	Get the parameter decoder for the specified handle.
virtual void	decode (DtInteractionRep *interaction, const RTI::ParameterHandleValueMap &pvMap)
	Decode the interaction.
virtual RTI::InteractionClassHandle	interactionClassHandle ()
	Get the interaction's class handle.
virtual DtInteractionDecoder *	clone () const
	Returns a new-ed clone of this object.
virtual DtInteractionDecoder *	clone (DtInterClassDesc *interDesc) const
	Returns a new-ed clone of this object which corresponds to the inter description interDesc.

Protected Member Functions
	DtDECLARE_COMMENT_PARAM_DECODER (OriginatingEntity)
	Individual parameter decoders.
	DtDECLARE_COMMENT_PARAM_DECODER (ReceivingEntity)
Protected Member Functions inherited from DtInteractionWithDataDecoder
	DtDECLARE_INTERWDATA_PARAM_DECODER (FixedDatums)
	Individual parameter decoders.
	DtDECLARE_INTERWDATA_PARAM_DECODER (VariableDatumSet)
Protected Member Functions inherited from DtInteractionDecoder
	DtInteractionDecoder (const DtInteractionDecoder &orig)
	copy constructor - not implemented.
DtInteractionDecoder &	operator= (const DtInteractionDecoder &orig)
	assignment operator - not implemented.
virtual void	decodeParameter (DtInteractionRep *inter, const RTI::ParameterHandleValuePairSet &pvList, int index)
	Process (decode) the specified parameter.

Additional Inherited Members
Public Types inherited from DtInteractionDecoder
typedef void(*	DtParameterDecoder )(DtInteractionRep *inter, const RTI::ParameterHandleValuePairSet &pvlist, int i)
	Parameter decoder function signature.
Static Public Member Functions inherited from DtInteractionDecoder
static char *	decodingBuffer (int length)
	Returns a pointer to a buffer that can be used to copy data obtained from a phvps.
static char *	parameterData (const RTI::ParameterHandleValuePairSet &pvList, int index, RTI::ULong &length)
	Returns a pointer to a buffer containing the parameter data.
static char *	parameterData (const RTI::ParameterHandleValuePairSet &pvList, int index, RTI::ULong &length, unsigned int expectedDataSize, char *paramName)
	Gets the parameter data and checks the expected size.
static DtNetEventId *	eventIdParameterData (const RTI::ParameterHandleValuePairSet &params, int index)
	Get the parameter data as a DtNetEventId (adds defensive null terminator) Returns a pointer to the parameter data.
static void	decodeGenericParameter (DtInteractionWithEncDec *inter, const RTI::ParameterHandleValuePairSet &pvlist, int i)
	Generic decoder class.
Static Public Attributes inherited from DtInteractionDecoder
static bool	theUseGetValuePointer
Static Protected Member Functions inherited from DtInteractionWithDataDecoder
static void	decodeVariableDatumSet_2_d_14 (DtInteractionWithData *inter, const RTI::ParameterHandleValuePairSet &params, int index)
static void	decodeVariableDatumSet_2_d_17 (DtInteractionWithData *inter, const RTI::ParameterHandleValuePairSet &params, int index)
Protected Attributes inherited from DtInteractionDecoder
DtExerciseConn *	myExConn
DtInterClassDesc *	myClassDesc
RTI::InteractionClassHandle	myClassHandle
std::map< RTI::ParameterHandle, DtParameterDecoder >	myList
	myList is an array of classDesc->maxParamHandle() items.

Detailed Description

Instances of DtCommentDecoder are used to decode Comment Interactions from the network.

Constructor & Destructor Documentation

DtCommentDecoder::DtCommentDecoder	(	DtExerciseConn *	exConn,
		DtInterClassDesc *	classDesc
	)

constructor

virtual DtCommentDecoder::~DtCommentDecoder ( )

virtual

destructor

DtCommentDecoder::DtCommentDecoder

(

const DtCommentDecoder &

orig

)

copy constructor

Member Function Documentation

DtCommentDecoder::DtDECLARE_COMMENT_PARAM_DECODER ( OriginatingEntity  )

protected

Individual parameter decoders.

DtCommentDecoder::DtDECLARE_COMMENT_PARAM_DECODER ( ReceivingEntity  )

protected

DtCommentDecoder& DtCommentDecoder::operator=

(

const DtCommentDecoder &

orig

)

assignment operator

---

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

• commentDecoder.h