DtReflectedEntity Class Reference

Instances of this class provide a protocol independent interface to a reflected entity in a DIS environment. More...

Inheritance diagram for DtReflectedEntity:

Collaboration diagram for DtReflectedEntity:

List of all members.

Public Types
typedef DtEntityStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEntityStateRepositories.
Public Member Functions
	DtReflectedEntity (DtExerciseConn *conn, const DtEntityIdentifier &id, const DtEntityType &type)
	Constructor.
virtual	~DtReflectedEntity ()
	Destructor.
virtual DtEntityStateRepository *	entityStateRep () const
	Returns a pointer to the EntityStateRepository - through which you can inspect current state information.
virtual DtEntityStateRepository *	esr () const
	Synonym for entityStateRep().
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtEntityStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages into our ESR.
virtual const DtEntityIdentifier &	entityId () const
	Returns the entity identifier.
virtual const DtObjectId &	id () const
	Get the entity's id. (For DIS, DtObjectId is DtEntityIdentifier).
virtual const DtObjectId &	localId () const
	Get the entity's local id. For DIS - same as id().
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the entity's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.
virtual void	processStateMessage (const DtStateMsg &msg)
	Process an entity state PDU. Calls processEntityState().
virtual void	processRelativeLocation (const DtRelativeLocationPdu &pdu)
	Process a relative location PDU.
virtual void	processEntityStateUpdate (const DtEntityStateUpdatePdu &pdu)
	Process an entity state update PDU.
virtual void	processSees (const DtSuppEmisEntStatePdu &pdu)
	Process an SEES PDU.
virtual void	processDiGuyPdu (const DtDIGuyCustomPdu &pdu)
	Process a DI Guy PDU.
virtual DtReflectedEntity *	next () const
	Get the next and previous elements in the reflected entity list.
virtual DtReflectedEntity *	prev () const
virtual DtReflectedEntity *	wrapNext () const
	Get the next and previous elements, wrap at the ends of the list.
virtual DtReflectedEntity *	wrapPrev () const
virtual void	addPostUpdateCallback (DtEntityCallbackFunction cb, void *userData)
	Entity state callback registration/deregistration.
virtual void	removePostUpdateCallback (DtEntityCallbackFunction cb, void *userData)
virtual const DtBaseHashKey &	hashKey () const
	Get a hash key for this object.
virtual DtString	idString () const
	Get a string identification of this object.
virtual void	processEntityState (const DtEntityStatePdu &pdu)
	Process an entity state PDU.
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
	DtReflectedEntity (const DtReflectedEntity &orig)
	copy constructor -- not implemented
DtReflectedEntity &	operator= (const DtReflectedEntity &orig)
	assignment operator -- not implemented
Protected Attributes
DtEntityIdentifier	myId
DtEntityStateRepository *	myEntityStateRep
DtEntityStateDecoder *	myEntityDecoder
DtEntityIdentifierHashKey	myHashKey
Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

---

Detailed Description

Instances of this class provide a protocol independent interface to a reflected entity in a DIS environment.

---

Member Typedef Documentation

typedef DtEntityStateRepository*(* DtReflectedEntity::DtStateRepCreator)()

Function prototype for functions that create DtEntityStateRepositories.

---

Constructor & Destructor Documentation

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

Constructor.

virtual DtReflectedEntity::~DtReflectedEntity

(

)

[virtual]

Destructor.

DtReflectedEntity::DtReflectedEntity

(

const DtReflectedEntity &

orig

)

[protected]

copy constructor -- not implemented

---

Member Function Documentation

virtual void DtReflectedEntity::addPostUpdateCallback	(	DtEntityCallbackFunction	cb,
		void *	userData
	)		[virtual]

Entity state callback registration/deregistration.

virtual DtEntityStateDecoder* DtReflectedEntity::decoder

(

)

[virtual]

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

virtual const DtEntityIdentifier& DtReflectedEntity::entityId

(

)

const [virtual]

Returns the entity identifier.

virtual DtEntityStateRepository* DtReflectedEntity::entityStateRep

(

)

const [virtual]

Returns a pointer to the EntityStateRepository - through which you can inspect current state information.

virtual DtEntityStateRepository* DtReflectedEntity::esr

(

)

const [virtual]

Synonym for entityStateRep().

virtual const DtGlobalObjectDesignator& DtReflectedEntity::globalId

(

)

const [virtual]

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

Implements DtReflectedObject.

virtual const DtBaseHashKey& DtReflectedEntity::hashKey

(

)

const [virtual]

Get a hash key for this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedEntity::id

(

)

const [virtual]

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

Referenced by localId().

virtual DtString DtReflectedEntity::idString

(

)

const [virtual]

Get a string identification of this object.

Implements DtReflectedObject.

const DtObjectId & DtReflectedEntity::localId

(

)

const [inline, virtual]

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

References id().

virtual DtReflectedEntity* DtReflectedEntity::next

(

)

const [virtual]

Get the next and previous elements in the reflected entity list.

Reimplemented from DtListedObj.

DtReflectedEntity& DtReflectedEntity::operator=

(

const DtReflectedEntity &

orig

)

[protected]

assignment operator -- not implemented

virtual DtReflectedEntity* DtReflectedEntity::prev

(

)

const [virtual]

Reimplemented from DtListedObj.

virtual void DtReflectedEntity::processDiGuyPdu

(

const DtDIGuyCustomPdu &

pdu

)

[virtual]

Process a DI Guy PDU.

virtual void DtReflectedEntity::processEntityState

(

const DtEntityStatePdu &

pdu

)

[virtual]

Process an entity state PDU.

Also calls down to base class processStateMessage().

virtual void DtReflectedEntity::processEntityStateUpdate

(

const DtEntityStateUpdatePdu &

pdu

)

[virtual]

Process an entity state update PDU.

virtual void DtReflectedEntity::processRelativeLocation

(

const DtRelativeLocationPdu &

pdu

)

[virtual]

Process a relative location PDU.

virtual void DtReflectedEntity::processSees

(

const DtSuppEmisEntStatePdu &

pdu

)

[virtual]

Process an SEES PDU.

virtual void DtReflectedEntity::processStateMessage

(

const DtStateMsg &

msg

)

[virtual]

Process an entity state PDU. Calls processEntityState().

Reimplemented from DtReflectedObject.

virtual void DtReflectedEntity::removePostUpdateCallback	(	DtEntityCallbackFunction	cb,
		void *	userData
	)		[virtual]

static void DtReflectedEntity::setStateRepCreator

(

DtStateRepCreator

creator

)

[static]

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedEntity::stateRep

(

)

const [virtual]

Returns a pointer to the StateRepository - through which you can inspect current state information.

Implementation for abstract base class. Calls esr().

Implements DtReflectedObject.

static DtStateRepCreator DtReflectedEntity::stateRepCreator

(

void

)

[static]

virtual DtReflectedEntity* DtReflectedEntity::wrapNext

(

)

const [virtual]

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

Reimplemented from DtListedObj.

virtual DtReflectedEntity* DtReflectedEntity::wrapPrev

(

)

const [virtual]

Reimplemented from DtListedObj.

---

Member Data Documentation

DtEntityStateDecoder* DtReflectedEntity::myEntityDecoder [protected]

DtEntityStateRepository* DtReflectedEntity::myEntityStateRep [protected]

DtEntityIdentifierHashKey DtReflectedEntity::myHashKey [protected]

DtEntityIdentifier DtReflectedEntity::myId [protected]

DtStateRepCreator DtReflectedEntity::theStateRepCreator [static, protected]

---

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

• dReflectedEnt.h