class DtEnvironmentObjectTransaction: More...

Inheritance diagram for DtEnvironmentObjectTransaction:

Collaboration diagram for DtEnvironmentObjectTransaction:

Public Member Functions
	DtEnvironmentObjectTransaction ()
	default constructor
virtual	~DtEnvironmentObjectTransaction ()
	destructor
	DtEnvironmentObjectTransaction (const DtEnvironmentObjectTransaction &orig)
	copy constructor
DtEnvironmentObjectTransaction &	operator= (const DtEnvironmentObjectTransaction &orig)
	assignment operator
virtual void	printData () const
	Print the interaction's data to DtInfo.
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the specified stream.
virtual void	setObjectId (const DtEntityIdentifier &identifier)
	Set/Get Environment Object ID.
virtual const DtEntityIdentifier &	objectId () const
virtual void	setReferencedObjectId (const DtGlobalObjectDesignator &rtiObject)
	Set/Get Referenced Object ID.
virtual const DtGlobalObjectDesignator &	referencedObjectId () const
virtual void	setForceId (const DtForceType value)
	Set/Get Force ID.
virtual DtForceType	forceId () const
virtual void	setObjectType (const DtSyntheticEnvironmentObjectType &type)
	Set/Get Object Type.
virtual const DtSyntheticEnvironmentObjectType &	objectType () const
virtual void	setRequestingId (const DtSimulationAddress &id)
	Set/Get Requesting ID.
virtual const DtSimulationAddress &	requestingId () const
virtual void	setReceivingId (const DtSimulationAddress &id)
	Set/Get Receiving ID.
virtual const DtSimulationAddress &	receivingId () const
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)
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.
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	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 DtEnvironmentObjectTransaction.
static void	addCallback (DtExerciseConn conn, DtEnvironmentObjectTransactionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn conn, DtEnvironmentObjectTransactionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtEntityIdentifier	myObjectId
DtGlobalObjectDesignator	myReferencedObjectId
DtForceType	myForceId
DtSyntheticEnvironmentObjectType	myObjectType
DtSimulationAddress	myRequestingId
DtSimulationAddress	myReceivingId
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
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 DtEnvironmentObjectTransaction:

Instances of DtEnvironmentObjectTransaction are used to represent Environment Object Transactions in the RPR FOM.

Constructor & Destructor Documentation

DtEnvironmentObjectTransaction::DtEnvironmentObjectTransaction ( )

default constructor

virtual DtEnvironmentObjectTransaction::~DtEnvironmentObjectTransaction ( )

virtual

destructor

DtEnvironmentObjectTransaction::DtEnvironmentObjectTransaction ( const DtEnvironmentObjectTransaction & orig )

copy constructor

Member Function Documentation

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

static

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

static DtInteraction* DtEnvironmentObjectTransaction::create ( )

static

Create a DtEnvironmentObjectTransaction.

Caller is responsible for deletion.

Reimplemented in DtPointObjectTransaction, DtLinearObjectTransaction, and DtArealObjectTransaction.

virtual DtForceType DtEnvironmentObjectTransaction::forceId ( ) const

virtual

virtual const char* DtEnvironmentObjectTransaction::name ( ) const

virtual

Name of the interaction. (Not necessarily the ClassName from the FOM.)

Implements DtInteraction.

Reimplemented in DtPointObjectTransaction, DtLinearObjectTransaction, and DtArealObjectTransaction.

virtual const DtEntityIdentifier& DtEnvironmentObjectTransaction::objectId ( ) const

virtual

virtual const DtSyntheticEnvironmentObjectType& DtEnvironmentObjectTransaction::objectType ( ) const

virtual

DtEnvironmentObjectTransaction& DtEnvironmentObjectTransaction::operator= ( const DtEnvironmentObjectTransaction & orig )

assignment operator

virtual void DtEnvironmentObjectTransaction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

Reimplemented in DtLinearObjectTransaction, DtArealObjectTransaction, and DtPointObjectTransaction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

Reimplemented in DtLinearObjectTransaction, DtArealObjectTransaction, and DtPointObjectTransaction.

virtual const DtSimulationAddress& DtEnvironmentObjectTransaction::receivingId ( ) const

virtual

virtual const DtGlobalObjectDesignator& DtEnvironmentObjectTransaction::referencedObjectId ( ) const

virtual

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

static

virtual const DtSimulationAddress& DtEnvironmentObjectTransaction::requestingId ( ) const

virtual

virtual void DtEnvironmentObjectTransaction::setForceId ( const DtForceType value )

virtual

Set/Get Force ID.

virtual void DtEnvironmentObjectTransaction::setObjectId ( const DtEntityIdentifier & identifier )

virtual

Set/Get Environment Object ID.

virtual void DtEnvironmentObjectTransaction::setObjectType ( const DtSyntheticEnvironmentObjectType & type )

virtual

Set/Get Object Type.

virtual void DtEnvironmentObjectTransaction::setReceivingId ( const DtSimulationAddress & id )

virtual

Set/Get Receiving ID.

virtual void DtEnvironmentObjectTransaction::setReferencedObjectId ( const DtGlobalObjectDesignator & rtiObject )

virtual

Set/Get Referenced Object ID.

virtual void DtEnvironmentObjectTransaction::setRequestingId ( const DtSimulationAddress & id )

virtual

Set/Get Requesting ID.

Member Data Documentation

DtForceType DtEnvironmentObjectTransaction::myForceId

protected

DtEntityIdentifier DtEnvironmentObjectTransaction::myObjectId

protected

DtSyntheticEnvironmentObjectType DtEnvironmentObjectTransaction::myObjectType

protected

DtSimulationAddress DtEnvironmentObjectTransaction::myReceivingId

protected

DtGlobalObjectDesignator DtEnvironmentObjectTransaction::myReferencedObjectId

protected

DtSimulationAddress DtEnvironmentObjectTransaction::myRequestingId

protected

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

environmentObjectTransaction.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation