Instances of DtReflectedFederateList manage a list of DtReflectedFederate objects. More...

Inheritance diagram for DtReflectedFederateList:

Collaboration diagram for DtReflectedFederateList:

Public Member Functions
	DtReflectedFederateList (DtExerciseConn *exConn, const DtString &updateRateTag=DtString(""))
	Constructor.
virtual	~DtReflectedFederateList ()
	Destructor.
virtual DtReflectedFederate *	lookup (RTI::ObjectInstanceHandle id)
	Look up by identifier.
virtual DtReflectedFederate *	lookup (const DtGlobalObjectDesignator &objName)
	Look up by name.
virtual DtReflectedFederate *	first () const
	Get the first reflected object in the list.
virtual DtReflectedFederate *	last () const
	Get the last reflected object in the list.
virtual void	addFederateAdditionCallback (DtFederateCallbackFunction cb, void *userData)
	Federate added callback registration.
virtual void	removeFederateAdditionCallback (DtFederateCallbackFunction cb, void *userData)
	Federate added callback deregistration.
virtual void	addFederateRemovalCallback (DtFederateCallbackFunction cb, void *userData)
	Federate removed callback registration.
virtual void	removeFederateRemovalCallback (DtFederateCallbackFunction cb, void *userData)
	Federate removed callback deregistration.
Public Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (DtExerciseConn exConn, const DtDDMRegionSet regionSetToUse=0, const DtString &updateRateTag=DtString(""))
	Constructor.
virtual	~DtReflectedObjectList ()
	destructor
virtual DtReflectedObject *	lookupObj (RTI::ObjectInstanceHandle id)
	Look up object by identifier.
virtual DtReflectedObject *	lookupObj (const DtGlobalObjectDesignator &objName)
	Look up object by global ID (which is the object name in RTI1.3.3).
virtual DtReflectedObject *	firstObj () const
	Get the first/last object in the list.
virtual DtReflectedObject *	lastObj () const
virtual int	count () const
	Get number of objects.
virtual DtExerciseConn *	exerciseConn () const
	Get my exerciseConn.
virtual void	manageObjectClass (RTI::ObjectClassHandle handle)
	Register callbacks with exercise connection so that we get notified when an object of this class is discovered.
virtual bool	removeObject (const DtObjectId &id)
	Have the application act as though we had never discovered the object.
virtual void	addObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object added callback registration/deregistration.
virtual void	removeObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual void	addObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object removed callback registration/deregistration.
virtual void	removeObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual void	print ()
	Print the SRs of all objects.
virtual void	setTimeoutProcessing (bool onOff)
	Set whether or not timeout processing occurs.
virtual void	setWaitListRefreshEnabled (bool on)
	Set whether or not we will request updates for objects which have not met discovery and are therefor wait listed.
virtual void	setTimeoutInterval (DtTime time)
	Set/Get the remote object timeout period.
virtual DtTime	timeoutInterval ()
virtual void	setWaitlistRefreshPeriod (DtTime time)
	Set/Get the wait list refresh period.
virtual DtTime	waitlistRefreshPeriod ()
virtual void	setDiscoveryCondition (DtDiscoveryCondition fn, void *usr)
	Set the checker function which will determine when an object gets discovered and put into the reflected list.
virtual void	clearDiscoveryCondition ()
	Unregisters the checker function set in setDiscoverCondition.
virtual const DtDDMRegionSet &	subscribedRegions ()
	Returns list of regions subscribed to.

Protected Member Functions
	DtReflectedFederateList (const DtReflectedFederateList &orig)
	Copy constructor not implemented - cannot be copied.
DtReflectedFederateList &	operator= (const DtReflectedFederateList &orig)
	Assignment operator not implemented - cannot be copied.
virtual DtReflectedObject *	newReflectedObject (DtHlaObject *obj) const
	Override of virtual function. Here, we create a DtReflectedFederate.
virtual void	objectAdded (DtReflectedObject *obj)
	Called from processDiscoverObject() after a remote Federate has been added to the list.
Protected Member Functions inherited from DtReflectedObjectList
virtual void	processDiscoverObject (DtHlaObject *obj)
	Process the discovery of a remote object on the network.
virtual void	processRemoveObject (DtHlaObject *obj)
	Process the removal of a remote object from the network.
virtual void	processTimedOutObjectReflect (const DtStateMsg &msg, DtHlaObject *obj)
	Handle the receipt of attributes for a remote object which was timed out.
virtual void	doTimeouts ()
	Remove any remote objects which have not been updated during the timeout period.
virtual void	doRequestWaitListUpdates ()
	Request an update for any objects which have not met their discovery criteria yet.
virtual void	removeAndDelete (DtReflectedObject obj, char msg=NULL)
	Remove the remote object from the list if found and delete it.
virtual bool	shouldBeTimedOut (DtReflectedObject *object)
	Returns whether or not the object should be timed out.
virtual void	timeOutObject (DtReflectedObject *object)
	Times out object by removing it from the remote object list and deleting it.
virtual void	unTimeOutObject (DtHlaObject *obj)
	Manages callbacks and data used for reinstating a remote object which was timed out.
virtual void	addObjectClass (RTI::ObjectClassHandle handle)
	Register interest in this FOM object class.
virtual void	addObjectClassByName (const char *className)
	Register interest in this FOM object class by className.
virtual void	init (const DtList *handleList)
	Register interest in a whole list of RTI::ObjectClassHandles all at once.
void	emptyLists ()
	Empty the object list and the timeout list.
void	emptyCallbackLists ()
	Empty the callback lists.
virtual void	processObjectAdditionCallbacks (DtReflectedObject *object)
	Process object addition/removal callbacks.
virtual void	processObjectRemovalCallbacks (DtReflectedObject *object)
virtual void	findAlreadyDiscoveredObjects ()
	When list is created, we call this function to go through the list of all discovered HLA objects to see if any should be managed by this list.
virtual void	checkDiscoveryCondition (DtReflectedObject *refObj)
virtual bool	readyToAdd (DtReflectedObject *obj)
	Returns true if the obj is ready to be added to myObjectList; calls myWaitListChecker from within.
virtual void	addToObjectList (DtReflectedObject *refObj)
	Add refObj to myObjectList and initiates discovery callbacks.
virtual DtReflectedObject *	lookupObjInWaitList (const DtGlobalObjectDesignator &name)
	Find object in waitList by name.
void	unsubscribeRegions ()

Additional Inherited Members
Static Public Member Functions inherited from DtReflectedObjectList
static void	setAutoSubscribeFlag (bool flag)
	Set/Get flag which determines whether to subscribe to object classes that this list manages.
static bool	autoSubscribeFlag ()
static void	setRequestClassUpdateFlag (bool onOff)
	Set/Get flag that determines whether we request updates from all objects of the object classes we subscribe to.
static bool	requestClassUpdateFlag ()
static void	setRequestObjectUpdateFlag (bool onOff)
	Set/Get flag that determines whether we request updates from an object as we discover it.
static bool	requestObjectUpdateFlag ()
static void	findDiscoveredObjectsCb (void *usr)
	Post-drain callback that calls findAlreadyDiscovedObjects().
Static Protected Member Functions inherited from DtReflectedObjectList
static void	discoverObjectCb (DtHlaObject hlaObj, void rel)
	Cast the void* to a DtReflectedObjectList* and calls processDiscoverObject().
static void	removeObjectCb (DtHlaObject hlaObj, void rel)
	Cast the void* to a DtReflectedObjectList* and calls processRemoveObject().
static void	timedOutObjectReflectCb (const DtStateMsg &msg, DtHlaObject obj, void usr)
	Cast the void* to a DtReflectedObjectList* and calls processTimedOutObjectReflect().
static void	doTimeoutsPostDrainCb (void *usr)
	Calls doTimeouts.
static void	doRequestWaitListUpdatesPostDrainCb (void *usr)
	Calls doRequestWaitListUpdates.
static void	postUpdateCb (DtReflectedObject obj, void usr)
	Calls checkDiscoveryCondition.
Protected Attributes inherited from DtReflectedObjectList
DtExerciseConn *	myExConn
DtObjectIdHashList	myObjectList
DtHashList	myObjectListByName
DtObjectIdHashList	myWaitList
DtList	myTimedOutObjectList
std::vector < RTI::ObjectClassHandle >	myHandleList
DtIntrusiveList	myObjectAddedCallbacks
DtIntrusiveList	myObjectRemovedCallbacks
DtTime	myTimeoutInterval
bool	myTimeoutProcessingFlag
bool	myWaitListRequestUpdateFlag
DtDiscoveryCondition	myDiscoveryCondition
void *	myDiscoveryConditionParameter
DtTime	myWaitlistTime
DtTime	myWaitlistRefreshPeriod
DtDDMRegionSet	mySubscribedRegions
DtString	myUpdateRateTag
Static Protected Attributes inherited from DtReflectedObjectList
static bool	theAutoSubscribeFlag
static bool	theRequestClassUpdateFlag
static bool	theRequestObjectUpdateFlag

Detailed Description

Instances of DtReflectedFederateList manage a list of DtReflectedFederate objects.

Constructor & Destructor Documentation

DtReflectedFederateList::DtReflectedFederateList	(	DtExerciseConn *	exConn,
		const DtString &	updateRateTag = `DtString("")`
	)

Constructor.

virtual DtReflectedFederateList::~DtReflectedFederateList ( )

virtual

Destructor.

DtReflectedFederateList::DtReflectedFederateList ( const DtReflectedFederateList & orig )

protected

Copy constructor not implemented - cannot be copied.

Member Function Documentation

virtual void DtReflectedFederateList::addFederateAdditionCallback	(	DtFederateCallbackFunction	cb,
		void *	userData
	)

virtual

Federate added callback registration.

virtual void DtReflectedFederateList::addFederateRemovalCallback	(	DtFederateCallbackFunction	cb,
		void *	userData
	)

virtual

Federate removed callback registration.

virtual DtReflectedFederate* DtReflectedFederateList::first ( ) const

virtual

Get the first reflected object in the list.

virtual DtReflectedFederate* DtReflectedFederateList::last ( ) const

virtual

Get the last reflected object in the list.

virtual DtReflectedFederate* DtReflectedFederateList::lookup ( RTI::ObjectInstanceHandle id )

virtual

Look up by identifier.

virtual DtReflectedFederate* DtReflectedFederateList::lookup ( const DtGlobalObjectDesignator & objName )

virtual

Look up by name.

virtual DtReflectedObject* DtReflectedFederateList::newReflectedObject ( DtHlaObject * obj ) const

protectedvirtual

Override of virtual function. Here, we create a DtReflectedFederate.

Implements DtReflectedObjectList.

virtual void DtReflectedFederateList::objectAdded ( DtReflectedObject * obj )

protectedvirtual

Called from processDiscoverObject() after a remote Federate has been added to the list.

Default implementation prints a message. Subclasses can override this function to add functionality on addition. obj will be an instance of a class derived from DtReflectedObj.

Reimplemented from DtReflectedObjectList.

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

protected

Assignment operator not implemented - cannot be copied.

virtual void DtReflectedFederateList::removeFederateAdditionCallback	(	DtFederateCallbackFunction	cb,
		void *	userData
	)

virtual

Federate added callback deregistration.

virtual void DtReflectedFederateList::removeFederateRemovalCallback	(	DtFederateCallbackFunction	cb,
		void *	userData
	)

virtual

Federate removed callback deregistration.

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

hReflFedList.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation