DtReflectedEntity Class Reference

Instances of DtReflectedEntity are used to represent a simulation entity reflected across a network (i.e. More...

Inheritance diagram for DtReflectedEntity:

Collaboration diagram for DtReflectedEntity:

Public Types
typedef DtEntityStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEntityStateRepositories.
typedef DtStateRepCreator	DtEsrCreator
Public Types inherited from DtReflectedObject
typedef DtStateRepository *(*	DtBaseStateRepCreator )()
	Function prototype for functions that create DtStateRepositories.

Public Member Functions
	DtReflectedEntity (DtHlaObject *obj, DtExerciseConn *conn)
	constructor
	DtReflectedEntity (DtExerciseConn *conn, DtEntityStateRepository *esrToUse)
	Constructor with state rep to use passed in Note that setHlaObject() should be called after a reflected entity is created with this method.
	DtReflectedEntity (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator esrToUse)
	Constructor with entity state repository creator passed in.
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 DtReflectedEntity *	next () const
	Get the next remote entity.
virtual DtReflectedEntity *	prev () const
	Get the previous remote entity.
virtual DtReflectedEntity *	wrapNext () const
	Get the next remote entity.
virtual DtReflectedEntity *	wrapPrev () const
	Get the previous remote entity.
virtual void	addPostUpdateCallback (DtEntityCallbackFunction cb, void *userData)
	Entity state callback registration/deregistration.
virtual void	removePostUpdateCallback (DtEntityCallbackFunction cb, void *userData)
virtual void	diGuyObjectUpdated ()
virtual DtOwnershipHandler *	setOwnershipHandler (DtOwnershipHandler *handler)
	Sets the current ownership handler to handler.
virtual void	acquireObject ()
	Pass through to the ownership manager.
virtual RTI::ObjectHandle	entityObjectId () const
	For backwards compatibility. Use id() instead.
Public Member Functions inherited from DtReflectedObject
	DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
	Primary constructor.
	DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor.
	DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor.
virtual	~DtReflectedObject ()
	destructor
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtStateRepository *	sr () const
	Synonym for stateRep().
virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages into our SR.
virtual DtHlaObjectWithStateRep *	hlaObject () const
	Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
virtual const DtObjectId &	objectId () const
	Get the HLA object's id.
virtual const DtObjectId &	id () const
	Get the HLA object's id (local ID).
virtual const DtObjectId &	localId () const
	Get the HLA object's id (local ID).
virtual const DtString &	name () const
	Get the HLA object name.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the HLA object's global object designator - the object name in HLA.
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of simulation time at the time an update was last received for the entity.
virtual DtTime	lastReceivedTimeStamp () const
	Returns the value of the time send in the last Update received for this entity.
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.
void	setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
	Start reflecting this object, using this decoder.
virtual void	setNoHlaObject (const DtObjectId &id, const DtGlobalObjectDesignator &des)
	Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object.
void	detachHlaObject ()
	Ends managing of current HLA object.
virtual void	requestUpdate ()
	Request that the owner of this entity send an attribute update.

Static Public Member Functions
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtEsrCreator	setEsrCreator (DtEsrCreator creator)
	For backwards compatibility.

Protected Member Functions
	DtReflectedEntity (const DtReflectedEntity &orig)
	copy constructor – Not Implemented
DtReflectedEntity &	operator= (const DtReflectedEntity &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.

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

Additional Inherited Members
Static Protected Member Functions inherited from DtReflectedObject
static void	requestUpdatePostDrainCb (void *usr)
	Calls requestUpdate.
static void	processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr)
	Callback from HlaObject to process post update callbacks.
Protected Attributes inherited from DtReflectedObject
DtExerciseConn *	myExConn
DtHlaObjectWithStateRep *	myHlaObj
DtStateRepository *	myStateRep
DtHlaStateDecoder *	myDecoder
bool	myRequestCbRegistered
DtIntrusiveList	myStateUpdateCallbacks
DtObjectId	myId
DtString	myName
DtRefHlaObjectMap::iterator	myReflIterator
DtRefHlaObjectMap *	myReflMap

Detailed Description

Instances of DtReflectedEntity are used to represent a simulation entity reflected across a network (i.e.

this is not a full simulation running on this machine).

Member Typedef Documentation

typedef DtStateRepCreator DtReflectedEntity::DtEsrCreator

Deprecated:

Use DtStateRepCreator instead.

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

Function prototype for functions that create DtEntityStateRepositories.

Constructor & Destructor Documentation

DtReflectedEntity::DtReflectedEntity	(	DtHlaObject *	obj,
		DtExerciseConn *	conn
	)

constructor

DtReflectedEntity::DtReflectedEntity	(	DtExerciseConn *	conn,
		DtEntityStateRepository *	esrToUse
	)

Constructor with state rep to use passed in Note that setHlaObject() should be called after a reflected entity is created with this method.

DtReflectedEntity::DtReflectedEntity	(	DtHlaObject *	obj,
		DtExerciseConn *	conn,
		DtBaseStateRepCreator	esrToUse
	)

Constructor with entity state repository creator passed in.

virtual DtReflectedEntity::~DtReflectedEntity ( )

virtual

destructor

DtReflectedEntity::DtReflectedEntity ( const DtReflectedEntity &  orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual void DtReflectedEntity::acquireObject ( )

virtual

Pass through to the ownership manager.

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

virtual

Entity state callback registration/deregistration.

virtual void DtReflectedEntity::diGuyObjectUpdated ( )

virtual

virtual RTI::ObjectHandle DtReflectedEntity::entityObjectId ( ) const

virtual

For backwards compatibility. Use id() instead.

DtEntityStateRepository * DtReflectedEntity::entityStateRep ( ) const

inlinevirtual

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

References DtReflectedObject::myStateRep.

DtEntityStateRepository * DtReflectedEntity::esr ( ) const

inlinevirtual

Synonym for entityStateRep().

References DtReflectedObject::myStateRep.

virtual DtReflectedEntity* DtReflectedEntity::next ( ) const

virtual

Get the next remote entity.

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

protected

assignment operator – Not Implemented

virtual DtReflectedEntity* DtReflectedEntity::prev ( ) const

virtual

Get the previous remote entity.

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

virtual

static DtEsrCreator DtReflectedEntity::setEsrCreator ( DtEsrCreator  creator )

static

For backwards compatibility.

Use setStateRepCreator instead. method setEsrCreator is deprecated and will be removed in the future

virtual DtOwnershipHandler* DtReflectedEntity::setOwnershipHandler ( DtOwnershipHandler *  handler )

virtual

Sets the current ownership handler to handler.

A DtOwnershipHandler is an object that encapsulates callback function for a variety of ownership-management-related functions. Returns previous handler.

static DtStateRepCreator DtReflectedEntity::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

virtual DtReflectedEntity* DtReflectedEntity::wrapNext ( ) const

virtual

Get the next remote entity.

Will cycle back to the first remote entity.

virtual DtReflectedEntity* DtReflectedEntity::wrapPrev ( ) const

virtual

Get the previous remote entity.

Will cycle back to the last remote entity.

Member Data Documentation

DtStateRepCreator DtReflectedEntity::theStateRepCreator

staticprotected

---

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

• reflectedEntityHLA.h