DtInteractionWithEncDec Class Reference

class DtInteractionWithEncDec: More...

Inheritance diagram for DtInteractionWithEncDec:

Collaboration diagram for DtInteractionWithEncDec:

List of all members.

Public Member Functions
	DtInteractionWithEncDec ()
	default constructor
virtual	~DtInteractionWithEncDec ()
	destructor
	DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
	copy constructor
DtInteractionWithEncDec &	operator= (const DtInteractionWithEncDec &orig)
	assignment operator
virtual void	setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL)
	Sets the interaction's ExerciseConn and class descriptor.
virtual const RTI::ParameterHandleValuePairSet &	phvps () const
	Get the parameter handle value pair set for the interaction.
virtual void	setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList)
	Set contents from a parameter handle value pair set.
virtual void	useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data)
	Specify an encoder, decoder, and interaction data repository to use in encoding and decoding.
virtual DtInteractionEncoder *	encoder () const
	Return the encoder we are using.
virtual DtInteractionDecoder *	decoder () const
	Return the decoder we are using.
Protected Member Functions
virtual DtInteractionDecoder *	createDecoder (DtExerciseConn *exConn) const
	Called by decoderToUse to obtain a new'ed decoder.
virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const
	Called by encoderToUse to obtain a new'ed encoder.
virtual DtInteractionDecoder *	decoderToUse (DtExerciseConn *exConn) const
	Returns a decoder to use for decoding the interaction.
virtual DtInteractionEncoder *	encoderToUse (DtExerciseConn *exConn) const
	Returns an encoder to use for encoding the interaction.
Protected Attributes
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
Private Attributes
DtInteractionDecoder *	myMutableCreatedDecoder
	These data members are changed in const functions.
DtInteractionEncoder *	myMutableCreatedEncoder
RTI::InteractionClassHandle	myMutableEncoderClassHandle
RTI::InteractionClassHandle	myMutableDecoderClassHandle

---

Detailed Description

class DtInteractionWithEncDec:

DtInteractionWithEncDec is a DtInteraction that uses an encoder and decoder to implement the virtual functions phvps and setFromPhvps.

---

Constructor & Destructor Documentation

DtInteractionWithEncDec::DtInteractionWithEncDec

(

)

default constructor

virtual DtInteractionWithEncDec::~DtInteractionWithEncDec

(

)

[virtual]

destructor

DtInteractionWithEncDec::DtInteractionWithEncDec

(

const DtInteractionWithEncDec &

orig

)

copy constructor

---

Member Function Documentation

virtual DtInteractionDecoder* DtInteractionWithEncDec::createDecoder

(

DtExerciseConn *

exConn

)

const [protected, virtual]

Called by decoderToUse to obtain a new'ed decoder.

Default implementation is to ask the FOM Mapper. The object is automatically deleted in the interaction's destructor.

Reimplemented in DtL16RadioSignalInteraction, TestInteraction, DtJtidsLetRadioSignalInteraction, DtJtidsMessageRadioSignalInteraction, DtVmfRadioSignalInteraction, DtJtidsVoiceCvsdRadioSignalInteraction, DtJtidsVoiceLpc10RadioSignalInteraction, DtJtidsVoiceLpc12RadioSignalInteraction, DtRttabRadioSignalInteraction, and DtRttReplyRadioSignalInteraction.

virtual DtInteractionEncoder* DtInteractionWithEncDec::createEncoder

(

DtExerciseConn *

exConn

)

const [protected, virtual]

Called by encoderToUse to obtain a new'ed encoder.

Default implementation is to ask the FOM Mapper. The object is automatically deleted in the interaction's destructor.

Reimplemented in DtL16RadioSignalInteraction, TestInteraction, DtJtidsLetRadioSignalInteraction, DtJtidsMessageRadioSignalInteraction, DtVmfRadioSignalInteraction, DtJtidsVoiceCvsdRadioSignalInteraction, DtJtidsVoiceLpc10RadioSignalInteraction, DtJtidsVoiceLpc12RadioSignalInteraction, DtRttabRadioSignalInteraction, and DtRttReplyRadioSignalInteraction.

DtInteractionDecoder * DtInteractionWithEncDec::decoder

(

)

const [inline, virtual]

Return the decoder we are using.

References myDecoder.

virtual DtInteractionDecoder* DtInteractionWithEncDec::decoderToUse

(

DtExerciseConn *

exConn

)

const [protected, virtual]

Returns a decoder to use for decoding the interaction.

DtInteractionEncoder * DtInteractionWithEncDec::encoder

(

)

const [inline, virtual]

Return the encoder we are using.

References myEncoder.

virtual DtInteractionEncoder* DtInteractionWithEncDec::encoderToUse

(

DtExerciseConn *

exConn

)

const [protected, virtual]

Returns an encoder to use for encoding the interaction.

DtInteractionWithEncDec& DtInteractionWithEncDec::operator=

(

const DtInteractionWithEncDec &

orig

)

assignment operator

virtual const RTI::ParameterHandleValuePairSet& DtInteractionWithEncDec::phvps

(

)

const [virtual]

Get the parameter handle value pair set for the interaction.

This is a slow function as the phvps is regenerated every time its called. Please do not count on the data in the phvps being correct after the function is called the second time.

Implements DtInteraction.

virtual void DtInteractionWithEncDec::setExConn	(	DtExerciseConn *	exConn,
		DtInterClassDesc *	classDesc = NULL
	)		[virtual]

Sets the interaction's ExerciseConn and class descriptor.

If classDesc is NULL, a default is chosen by calling interactionClassToUse(). Without being told what ExConn or class descriptor to use, many of the HLA-specific functions won't work properly. However, it is usually not necessary for application code to call this function, since it is called by DtExerciseConn::send on the outgoing side, and by the DtInteractionFactory on the incoming side.

Reimplemented from DtInteraction.

virtual void DtInteractionWithEncDec::setFromPhvps

(

const RTI::ParameterHandleValuePairSet &

pvList

)

[virtual]

Set contents from a parameter handle value pair set.

Implements DtInteraction.

virtual void DtInteractionWithEncDec::useThese	(	DtInteractionEncoder *	enc,
		DtInteractionDecoder *	dec,
		DtInteractionRep *	data
	)		[virtual]

Specify an encoder, decoder, and interaction data repository to use in encoding and decoding.

Called by setExConn (using encoder and decoder obtained through encoderToUse() and decoderToUse()) so call AFTER setExConn if you want to override defaults. Caller is responsible for deleting enc, dec and data, but should do so only after they are no longer used by the interaction.

---

Member Data Documentation

DtInteractionRep* DtInteractionWithEncDec::myData [protected]

Reimplemented in DtJtidsVoiceCvsdRadioSignalInteraction, DtJtidsVoiceLpc10RadioSignalInteraction, and DtJtidsVoiceLpc12RadioSignalInteraction.

DtInteractionDecoder* DtInteractionWithEncDec::myDecoder [protected]

Referenced by decoder().

DtInteractionEncoder* DtInteractionWithEncDec::myEncoder [protected]

Referenced by encoder().

DtInteractionDecoder* DtInteractionWithEncDec::myMutableCreatedDecoder [mutable, private]

These data members are changed in const functions.

They are computed when we go to send an interaction and are cashed.

DtInteractionEncoder* DtInteractionWithEncDec::myMutableCreatedEncoder [mutable, private]

RTI::InteractionClassHandle DtInteractionWithEncDec::myMutableDecoderClassHandle [mutable, private]

RTI::InteractionClassHandle DtInteractionWithEncDec::myMutableEncoderClassHandle [mutable, private]

---

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

• hIntWEncDec.h