DtReflectedFederate Class Reference

This class contains information about a Federate instance in HLA. More...

Inheritance diagram for DtReflectedFederate:

Collaboration diagram for DtReflectedFederate:

Public Member Functions
	DtReflectedFederate (DtHlaObject *obj, DtExerciseConn *exConn)
	Constructor.
virtual	~DtReflectedFederate ()
	Destructor.
virtual DtFederateStateRepository *	federateRep () const
	Returns the Federate's state repository.
virtual DtFederateStateRepository *	fsr () const
	Shorter version of lifeformRep.
virtual DtReflectedFederate *	next () const
	Returns the next reflected Federate in the DtReflectedFederateList.
virtual DtReflectedFederate *	prev () const
	Returns the previous reflected Federate in the DtReflectedFederateList.
virtual DtReflectedFederate *	wrapNext () const
	Returns the next reflected Federate.
virtual DtReflectedFederate *	wrapPrev () const
	Returns the previous reflected Federate.
virtual void	addPostUpdateCallback (DtFederateCallbackFunction cb, void *userData)
	Add a callback that is called when the DtReflectedFederate is updated.
virtual void	removePostUpdateCallback (DtFederateCallbackFunction cb, void *userData)
	Remove the callback that is called when the DtReflectedFederate is updated.
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)
	Set the function to be called for creating state repositories.

Protected Member Functions
	DtReflectedFederate (const DtReflectedFederate &orig)
	Copy Constructor not implemented.
DtReflectedFederate &	operator= (const DtReflectedFederate &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
	The function called to create state repositories.

Private Types
typedef DtFederateStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create a DtFederateStateRepository.

Additional Inherited Members
Public Types inherited from DtReflectedObject
typedef DtStateRepository *(*	DtBaseStateRepCreator )()
	Function prototype for functions that create DtStateRepositories.
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

This class contains information about a Federate instance in HLA.

The data is populated from MOM data transmitted by the RTI as part of the HLA Standard.

Member Typedef Documentation

typedef DtFederateStateRepository*(* DtReflectedFederate::DtStateRepCreator)()

private

Function prototype for functions that create a DtFederateStateRepository.

Constructor & Destructor Documentation

DtReflectedFederate::DtReflectedFederate	(	DtHlaObject *	obj,
		DtExerciseConn *	exConn
	)

Constructor.

virtual DtReflectedFederate::~DtReflectedFederate ( )

virtual

Destructor.

DtReflectedFederate::DtReflectedFederate ( const DtReflectedFederate &  orig )

protected

Copy Constructor not implemented.

Member Function Documentation

virtual void DtReflectedFederate::addPostUpdateCallback ( DtFederateCallbackFunction  cb, void *  userData  )

virtual

Add a callback that is called when the DtReflectedFederate is updated.

DtFederateStateRepository * DtReflectedFederate::federateRep ( ) const

inlinevirtual

Returns the Federate's state repository.

References DtReflectedObject::myStateRep.

DtFederateStateRepository * DtReflectedFederate::fsr ( ) const

inlinevirtual

Shorter version of lifeformRep.

References DtReflectedObject::myStateRep.

virtual DtReflectedFederate* DtReflectedFederate::next ( ) const

virtual

Returns the next reflected Federate in the DtReflectedFederateList.

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

protected

Assignment operator not implemented.

virtual DtReflectedFederate* DtReflectedFederate::prev ( ) const

virtual

Returns the previous reflected Federate in the DtReflectedFederateList.

virtual void DtReflectedFederate::removePostUpdateCallback ( DtFederateCallbackFunction  cb, void *  userData  )

virtual

Remove the callback that is called when the DtReflectedFederate is updated.

static DtStateRepCreator DtReflectedFederate::setStateRepCreator ( DtStateRepCreator  creator )

static

Set the function to be called for creating state repositories.

virtual DtReflectedFederate* DtReflectedFederate::wrapNext ( ) const

virtual

Returns the next reflected Federate.

Will cycle back to the first remote Federate in the DtReflectedFederateList.

virtual DtReflectedFederate* DtReflectedFederate::wrapPrev ( ) const

virtual

Returns the previous reflected Federate.

Will cycle back to the first remote Federate in the DtReflectedFederateList.

Member Data Documentation

DtStateRepCreator DtReflectedFederate::theStateRepCreator

staticprotected

The function called to create state repositories.

---

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

• reflectedFederate.h