class DtTransferControlInteraction: More...

Inheritance diagram for DtTransferControlInteraction:

Collaboration diagram for DtTransferControlInteraction:

Public Member Functions
	DtTransferControlInteraction ()
	default constructor
	DtTransferControlInteraction (const DtTransferControlInteraction &other)
	copy constructor
virtual	~DtTransferControlInteraction ()
	destructor
DtTransferControlInteraction &	operator= (const DtTransferControlInteraction &other)
	assignment operator
virtual void	printData () const
	Print out interaction's data to DtInfo.
virtual void	printDataToStream (std::ostream &stream) const
	Print out interaction's data to the specified stream.
virtual void	setOriginatingEntityID (const DtEntityIdentifier &entity)
	Set/Get originator ID.
virtual const DtEntityIdentifier &	originatingEntityID () const
virtual void	setReceivingEntityID (const DtEntityIdentifier &entity)
	Set/Get receiver ID.
virtual const DtEntityIdentifier	receivingEntityID () const
virtual void	setRequestID (DtU32 id)
	Set/Get request ID.
virtual DtU32	requestID () const
virtual void	setTransferType (const DtTransferType type)
	Set/Get the transfer Type.
virtual const DtTransferType	transferType () const
virtual void	setTransferredEntityID (const DtGlobalObjectDesignator &)
	Set/Get the transferEntity.
virtual const DtGlobalObjectDesignator &	transferredEntityID () const
virtual void	setNumRecordSets (DtU32 number)
	Set/Get the number of record sets in this list.
virtual DtU32	numRecordSets () const
virtual bool	setRecordSet (int index, const DtRecordSet &set)
	Set/Get the record set at the specified index.
virtual const DtRecordSet &	recordSet (int index, bool *valid=NULL)
virtual bool	getRecordSet (int index, DtRecordSet &recSet) const
	a separate Get Function For backwards Compatibility
virtual const DtRecordSetList &	recordSetList () const
	They exist for the mapper to use for conversion to net data.
virtual DtRecordSetList *	recordSetList ()
virtual const char *	name () const
	name of the interaction.
Public Member Functions inherited from DtInteractionWithEncDec
	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.
virtual void	setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
	Set the Parameter with the given handle.
virtual const char *	getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given handle.
virtual void	setParameterByName (const DtString &name, const char *attrValue, unsigned size)
	Set the Parameter with the given name.
virtual const char *	getParameterByName (const DtString &name, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given name.
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
virtual RTI::InteractionClassHandle	interactionClassHandle () const
	Get the interaction class handle. Returns 0 if no classDesc.
virtual char *	interactionClassName () const
	Get the interaction class name. Returns NULL if no classDesc.
virtual int	numParameters () const
	Get the number of parameters. Returns 0 if no classDesc.
virtual bool	neededByFederation () const
	Returns true if the interaction class is needed by the federation false otherwise.
virtual void	print () const
	Print the interaction's host rep data, including header.
virtual void	printToStream (std::ostream &stream) const
	Print the interaction to a stream.
virtual void	printHeader () const
	Print the header info.
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header info to a stream.
virtual void	printDataToString (DtString &buff) const
	Print the interaction's data to the string provided.
virtual void	printParams (bool withHex) const
	Print the header followed by the interaction's parameters.
virtual void	printParamsToStream (std::ostream &stream, bool withHex) const
	Print the header followed by the interaction's parameters to a stream.
virtual DtExerciseConn *	exerciseConn () const
	Get the current exercise connection.
virtual DtInterClassDesc *	classDesc () const
	Get the current class descriptor we're using for this interaction.
virtual bool	customTagSet () const
	Get whether a custom tag has been set on the interaction or not.
virtual void	setCustomTag (const DtString &a_tag)
	Set the user-defined tag.
virtual void	setTag (const DtString &tag)
	Set the user-defined tag.
virtual const DtString &	tag () const
	Get the user-defined tag.
virtual const RTI::Region *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message.
virtual void	setConveyedRegion (const RTI::Region *region)
virtual void	setProducingFederateHandle (RTI::FederateHandle federateHandle)
	HLA Evolved added an argument that provides the FederateHandle of the federate that produced the interaction being received.
virtual RTI::FederateHandle	producingFederateHandle () const
	The producing federate handle. Invalid if not enabled (or could be from MOM).
virtual const DtString &	producingFederateName () const
	The producing federate handle is used to get the federate name (cached after first access).
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the time of validity of the message, and whether this represents relative or absolute time.
virtual DtTime	timeStamp () const
	Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual void	setFedTime (const RTI::FedTime &ft)
	This is used for TSO interactions.
virtual const RTI::FedTime *	fedTime () const
	When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set.
virtual void	setEventRetractionHandle (const RTI::EventRetractionHandle &handle)
	Get/Set the EventRetractionHandle.
virtual RTI::EventRetractionHandle	eventRetractionHandle () const
	Get the event retraction handle. For more info see setEventRetractionHandle.

Static Public Member Functions
static DtInteraction *	create ()
	Create a DtTransferControlInteraction.
static void	addCallback (DtExerciseConn conn, DtTransferControlInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register) / remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn conn, DtTransferControlInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtEntityIdentifier	myOriginatingEnt
DtEntityIdentifier	myReceivingEnt
DtU32	myRequestId
DtGlobalObjectDesignator	myTransferEntity
DtTransferType	myTransferType
DtRecordSetList	myRecordSetList
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
std::map< RTI::ParameterHandle, DtGenericParameterInfo * >	myParametersByHandle
	parameters by handle.
Protected Attributes inherited from DtInteraction
DtInterClassDesc *	myClassDesc
DtExerciseConn *	myExConn
DtTime	myTime
DtTimeStampType	myTimeType
DtString	myTag
RTI::ParameterHandleValuePairSet *	myPvList
int	myPvListMaxSize
RTI::FedTime *	myFedTime
RTI::EventRetractionHandle	myRetractionHandle
const RTI::Region *	myConveyedRegion
bool	myCustomTagSet

Additional Inherited Members
Protected Member Functions inherited from DtInteractionWithEncDec
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.
Static Protected Attributes inherited from DtInteraction
static bool	theTagIsAsciiTime

Detailed Description

class DtTransferControlInteraction:

Instances of DtTransferControl are used to represent TransfterControl Interactions in the FOM.

Constructor & Destructor Documentation

DtTransferControlInteraction::DtTransferControlInteraction ( )

default constructor

DtTransferControlInteraction::DtTransferControlInteraction ( const DtTransferControlInteraction & other )

copy constructor

virtual DtTransferControlInteraction::~DtTransferControlInteraction ( )

virtual

destructor

Member Function Documentation

static void DtTransferControlInteraction::addCallback	(	DtExerciseConn *	conn,
		DtTransferControlInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)

static

Add (register) / remove (deregister) function to be called when interaction occurs.

static DtInteraction* DtTransferControlInteraction::create ( )

static

Create a DtTransferControlInteraction.

Caller is responsible for the deletion

virtual bool DtTransferControlInteraction::getRecordSet	(	int	index,
		DtRecordSet &	recSet
	)		const

virtual

a separate Get Function For backwards Compatibility

const char * DtTransferControlInteraction::name ( ) const

inlinevirtual

name of the interaction.

(Not necessarily the ClassName from the FOM)

Implements DtInteraction.

virtual DtU32 DtTransferControlInteraction::numRecordSets ( ) const

virtual

DtTransferControlInteraction& DtTransferControlInteraction::operator= ( const DtTransferControlInteraction & other )

assignment operator

const DtEntityIdentifier & DtTransferControlInteraction::originatingEntityID ( ) const

inlinevirtual

References myOriginatingEnt.

virtual void DtTransferControlInteraction::printData ( ) const

virtual

Print out interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtTransferControlInteraction::printDataToStream ( std::ostream & stream ) const

virtual

Print out interaction's data to the specified stream.

Reimplemented from DtInteraction.

const DtEntityIdentifier DtTransferControlInteraction::receivingEntityID ( ) const

inlinevirtual

References myReceivingEnt.

virtual const DtRecordSet& DtTransferControlInteraction::recordSet	(	int	index,
		bool *	valid = `NULL`
	)

virtual

const DtRecordSetList & DtTransferControlInteraction::recordSetList ( ) const

inlinevirtual

They exist for the mapper to use for conversion to net data.

References myRecordSetList.

DtRecordSetList * DtTransferControlInteraction::recordSetList ( )

inlinevirtual

References myRecordSetList.

static void DtTransferControlInteraction::removeCallback	(	DtExerciseConn *	conn,
		DtTransferControlInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)