DtInteractionEncoder Class Reference

DtInteractionEncoder is used to provide encoding of an interaction into an RTI::ParameterHandleValuePairSet in an HLA (as opposed to DIS) environment. More...

Inheritance diagram for DtInteractionEncoder:

Collaboration diagram for DtInteractionEncoder:

List of all members.

Public Types
typedef void(*	DtParameterEncoder )(const DtInteractionRep &inter, RTI::ParameterHandleValuePairSet *avlist, RTI::ParameterHandle handle)
	Attribute encoding function declaration.
Public Member Functions
	DtInteractionEncoder (DtExerciseConn *exConn, DtInterClassDesc *classDesc)
	constructor
virtual	~DtInteractionEncoder ()
	destructor
	DtInteractionEncoder (const DtInteractionEncoder &orig)
	copy constructor
DtInteractionEncoder &	operator= (const DtInteractionEncoder &orig)
	assignment operator
virtual DtParameterEncoder	addEncoder (RTI::ParameterHandle hand, DtParameterEncoder func)
	Add a parameter encoder function by parameter handle.
virtual DtParameterEncoder	addEncoder (char *name, DtParameterEncoder proc)
	Add a parameter encoder function by parameter name.
virtual DtParameterEncoder	encoder (RTI::ParameterHandle hand)
	Get the parameter encoder for the specified handle.
virtual void	encode (const DtInteractionRep &inter, RTI::ParameterHandleValuePairSet *pvList)
	Encode necessary values from the protocol-independent interaction.
virtual RTI::InteractionClassHandle	interClassHandle ()
	Get the object's class handle.
virtual DtInteractionEncoder *	clone () const
	Returns a new-ed clone of this object.
virtual DtInteractionEncoder *	clone (DtInterClassDesc *interDesc) const
	Returns a new-ed clone of this object which corresponds to the inter description interDesc.
Protected Attributes
DtExerciseConn *	myExConn
DtInterClassDesc *	myClassDesc
DtVrlRtiAmbassador *	myRtiAmb
RTI::InteractionClassHandle	myHandle
std::map< RTI::ParameterHandle, DtParameterEncoder >	myList
	myList is an array of classDesc->maxParamHandle() items.

---

Detailed Description

DtInteractionEncoder is used to provide encoding of an interaction into an RTI::ParameterHandleValuePairSet in an HLA (as opposed to DIS) environment.

---

Member Typedef Documentation

typedef void(* DtInteractionEncoder::DtParameterEncoder)(const DtInteractionRep &inter, RTI::ParameterHandleValuePairSet *avlist, RTI::ParameterHandle handle)

Attribute encoding function declaration.

---

Constructor & Destructor Documentation

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

constructor

virtual DtInteractionEncoder::~DtInteractionEncoder

(

)

[virtual]

destructor

DtInteractionEncoder::DtInteractionEncoder

(

const DtInteractionEncoder &

orig

)

copy constructor

---

Member Function Documentation

virtual DtParameterEncoder DtInteractionEncoder::addEncoder	(	RTI::ParameterHandle	hand,
		DtParameterEncoder	func
	)		[virtual]

Add a parameter encoder function by parameter handle.

Returns any previous parameter encoder function which was replaced by the add.

virtual DtParameterEncoder DtInteractionEncoder::addEncoder	(	char *	name,
		DtParameterEncoder	proc
	)		[virtual]

Add a parameter encoder function by parameter name.

Returns any previous parameter encoder function which was replaced by the add.

virtual DtInteractionEncoder* DtInteractionEncoder::clone

(

)

const [virtual]

Returns a new-ed clone of this object.

virtual DtInteractionEncoder* DtInteractionEncoder::clone

(

DtInterClassDesc *

interDesc

)

const [virtual]

Returns a new-ed clone of this object which corresponds to the inter description interDesc.

Use this function if you want a subclass in the FOM to use the same encoder as its parent.

virtual void DtInteractionEncoder::encode	(	const DtInteractionRep &	inter,
		RTI::ParameterHandleValuePairSet *	pvList
	)		[virtual]

Encode necessary values from the protocol-independent interaction.

DtInteractionEncoder::DtParameterEncoder DtInteractionEncoder::encoder

(

RTI::ParameterHandle

hand

)

[inline, virtual]

Get the parameter encoder for the specified handle.

References myList.

RTI::InteractionClassHandle DtInteractionEncoder::interClassHandle

(

)

[inline, virtual]

Get the object's class handle.

References myHandle.

DtInteractionEncoder& DtInteractionEncoder::operator=

(

const DtInteractionEncoder &

orig

)

assignment operator

---

Member Data Documentation

DtInterClassDesc* DtInteractionEncoder::myClassDesc [protected]

DtExerciseConn* DtInteractionEncoder::myExConn [protected]

RTI::InteractionClassHandle DtInteractionEncoder::myHandle [protected]

Referenced by interClassHandle().

std::map<RTI::ParameterHandle, DtParameterEncoder> DtInteractionEncoder::myList [protected]

myList is an array of classDesc->maxParamHandle() items.

Referenced by encoder().

DtVrlRtiAmbassador* DtInteractionEncoder::myRtiAmb [protected]

---

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

• interEncoder.h