DtReflectedEnvironmentProcess Class Reference

The DtReflectedObject instance for an Environmental Process Object. More...

Inheritance diagram for DtReflectedEnvironmentProcess:

Collaboration diagram for DtReflectedEnvironmentProcess:

Public Types
typedef DtEnvironmentProcessRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEnvironmentProcessRepositories.

Public Member Functions
	DtReflectedEnvironmentProcess (DtExerciseConn *conn, const DtEntityIdentifier &id, const DtEntityType &type)
	constructor
virtual	~DtReflectedEnvironmentProcess ()
	destructor
virtual DtEnvironmentProcessRepository *	environmentProcessStateRep () const
	Returns ptr to environmentProcessStateRepository – through which you can inspect current state info.
virtual DtEnvironmentProcessRepository *	epsr () const
	Synonym for environmentStateRep.
virtual DtStateRepository *	stateRep () const
	Implementation for abstract base class. Calls epsr().
virtual DtEnvironmentProcessDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages into our EPSR.
virtual const DtEntityIdentifier &	entityId () const
	Returns the entity identifier.
virtual const DtObjectId &	id () const
	Get the environment process's id. (For DIS, DtObjectId is DtEntityIdentifier).
virtual const DtObjectId &	localId () const
	Get the environment process's local id. For DIS - same as id().
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the environment process's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.
virtual void	processStateMessage (const DtStateMsg &msg)
	Process an environment process state PDU.
virtual DtReflectedEnvironmentProcess *	next () const
	Get the next and previous elements in the reflected environment process list.
virtual DtReflectedEnvironmentProcess *	prev () const
virtual DtReflectedEnvironmentProcess *	wrapNext () const
	Get the next and previous elements, wrap at the ends of the list.
virtual DtReflectedEnvironmentProcess *	wrapPrev () const
virtual void	addPostUpdateCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
	Environment Process callback registration/deregistration.
virtual void	removePostUpdateCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
virtual const DtBaseHashKey &	hashKey () const
	Get a hhash key for this object.
virtual DtString	idString () const
	Get a string identification of this object.
virtual void	processEnvironmentProcess (const DtEnvironmentalProcessPdu &pdu)
	Process an environmentalProcess PDU.
Public Member Functions inherited from DtReflectedObject
	DtReflectedObject (DtExerciseConn *conn)
	constructor
virtual	~DtReflectedObject ()
	destructor
virtual DtStateRepository *	sr () const
	Synonym for stateRep().
virtual DtTime	lastTimeUpdated () const
	Returns the value of wallclock time at the time an update was last received for the entity.
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of sim time at the time an update was last received for the entity.
virtual DtTime	lastReceivedTimeStamp () const
	Returns the value in seconds past the hour of the timeStamp from the last received PDU.
virtual void	baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object state callback registration/deregistration.
virtual void	baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual DtReflectedObject *	nextObj () const
	Get the next remote object.
virtual DtReflectedObject *	prevObj () const
	Get the previous remote object.
virtual DtReflectedObject *	wrapNextObj () const
	Get the next remote object.
virtual DtReflectedObject *	wrapPrevObj () const
	Get the previous remote object.
Public Member Functions inherited from DtListedObj
	DtListedObj ()
	Constructor.
virtual	~DtListedObj ()
	Destructor.

Static Public Member Functions
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator (void)

Protected Member Functions
	DtReflectedEnvironmentProcess (const DtReflectedEnvironmentProcess &orig)
	copy constructor – not implemented
DtReflectedEnvironmentProcess &	operator= (const DtReflectedEnvironmentProcess &orig)
	assignment operator – not implemented
Protected Member Functions inherited from DtReflectedObject
	DtReflectedObject (const DtReflectedObject &orig)
	copy constructor – not implemented
DtReflectedObject &	operator= (const DtReflectedObject &orig)
	assignment operator – not implemented
virtual void	processPostUpdateCallbacks ()
	Process the post update callbacks.

Protected Attributes
DtEntityIdentifier	myId
DtEnvironmentProcessRepository *	myStateRep
DtEnvironmentProcessDecoder *	myDecoder
DtEntityIdentifierHashKey	myHashKey
Protected Attributes inherited from DtReflectedObject
DtExerciseConn *	myExConn
DtIntrusiveList	myStateUpdateCallbacks
DtTime	myLastTimeUpdated
DtTime	myLastSimTimeUpdated
DtTime	myLastReceivedTimeStamp
Protected Attributes inherited from DtListedObj
DtList *	myList
DtListItem *	myItem

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

Detailed Description

The DtReflectedObject instance for an Environmental Process Object.

Examples: Environmental Process Example

Member Typedef Documentation

typedef DtEnvironmentProcessRepository*(* DtReflectedEnvironmentProcess::DtStateRepCreator)()

Function prototype for functions that create DtEnvironmentProcessRepositories.

Constructor & Destructor Documentation

DtReflectedEnvironmentProcess::DtReflectedEnvironmentProcess	(	DtExerciseConn *	conn,
		const DtEntityIdentifier &	id,
		const DtEntityType &	type
	)

constructor

virtual DtReflectedEnvironmentProcess::~DtReflectedEnvironmentProcess ( )

virtual

destructor

DtReflectedEnvironmentProcess::DtReflectedEnvironmentProcess ( const DtReflectedEnvironmentProcess &  orig )

protected

copy constructor – not implemented

Member Function Documentation

virtual void DtReflectedEnvironmentProcess::addPostUpdateCallback ( DtEnvironmentProcessCallbackFunction  cb, void *  userData  )

virtual

Environment Process callback registration/deregistration.

virtual DtEnvironmentProcessDecoder* DtReflectedEnvironmentProcess::decoder ( )

virtual

Returns a pointer to the Decoder being used to decode state messages into our EPSR.

virtual const DtEntityIdentifier& DtReflectedEnvironmentProcess::entityId ( ) const

virtual

Returns the entity identifier.

virtual DtEnvironmentProcessRepository* DtReflectedEnvironmentProcess::environmentProcessStateRep ( ) const

virtual

Returns ptr to environmentProcessStateRepository – through which you can inspect current state info.

virtual DtEnvironmentProcessRepository* DtReflectedEnvironmentProcess::epsr ( ) const

virtual

Synonym for environmentStateRep.

virtual const DtGlobalObjectDesignator& DtReflectedEnvironmentProcess::globalId ( ) const

virtual

Get the environment process's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.

Implements DtReflectedObject.

virtual const DtBaseHashKey& DtReflectedEnvironmentProcess::hashKey ( ) const

virtual

Get a hhash key for this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedEnvironmentProcess::id ( ) const

virtual

Get the environment process's id. (For DIS, DtObjectId is DtEntityIdentifier).

virtual DtString DtReflectedEnvironmentProcess::idString ( ) const

virtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedEnvironmentProcess::localId ( ) const

virtual

Get the environment process's local id. For DIS - same as id().

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::next ( ) const

virtual

Get the next and previous elements in the reflected environment process list.

Reimplemented from DtListedObj.

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

protected

assignment operator – not implemented

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::prev ( ) const

virtual

Reimplemented from DtListedObj.

virtual void DtReflectedEnvironmentProcess::processEnvironmentProcess ( const DtEnvironmentalProcessPdu &  pdu )

virtual

Process an environmentalProcess PDU.

Also calls down to base class processStateMessage().

virtual void DtReflectedEnvironmentProcess::processStateMessage ( const DtStateMsg &  msg )

virtual

Process an environment process state PDU.

Calls processEnvironmentProcess().

Reimplemented from DtReflectedObject.

virtual void DtReflectedEnvironmentProcess::removePostUpdateCallback ( DtEnvironmentProcessCallbackFunction  cb, void *  userData  )

virtual

static void DtReflectedEnvironmentProcess::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedEnvironmentProcess::stateRep ( ) const

virtual

Implementation for abstract base class. Calls epsr().

Implements DtReflectedObject.

static DtStateRepCreator DtReflectedEnvironmentProcess::stateRepCreator ( void  )

static

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::wrapNext ( ) const

virtual

Get the next and previous elements, wrap at the ends of the list.

Reimplemented from DtListedObj.

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::wrapPrev ( ) const

virtual

Reimplemented from DtListedObj.

Member Data Documentation

DtEnvironmentProcessDecoder* DtReflectedEnvironmentProcess::myDecoder

protected

DtEntityIdentifierHashKey DtReflectedEnvironmentProcess::myHashKey

protected

DtEntityIdentifier DtReflectedEnvironmentProcess::myId

protected

DtEnvironmentProcessRepository* DtReflectedEnvironmentProcess::myStateRep

protected

DtStateRepCreator DtReflectedEnvironmentProcess::theStateRepCreator

staticprotected

---

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

• reflectedEnvironmentProcessDIS.h