DtEnvironmentObjectTransaction Class Reference

class DtEnvironmentObjectTransaction: More...

Inheritance diagram for DtEnvironmentObjectTransaction:

Collaboration diagram for DtEnvironmentObjectTransaction:

List of all members.

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.)
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

---

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:

• hEnvObjTrans.h