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

Inheritance diagram for DtReflectedArealObjectList:

Collaboration diagram for DtReflectedArealObjectList:

Public Member Functions
	DtReflectedArealObjectList (DtExerciseConn *exConn, int numBucketsPrimeNumber=503)
	CTOR. More...

virtual	~DtReflectedArealObjectList ()
	Virtual DTOR. More...

virtual DtReflectedArealObject *	lookup (const DtEntityIdentifier &id) const
	Lookup a Areal Object from the Event ID. More...

virtual DtReflectedArealObject *	first () const
	Get the first and last elements of the reflected Areal Object's list. More...

virtual DtReflectedArealObject *	last () const

virtual void	addArealObjectAdditionCallback (DtArealObjectCallbackFunction cb, void *usr)
	"Areal Object Added" callback registration/deregistration. More...

virtual void	removeArealObjectAdditionCallback (DtArealObjectCallbackFunction cb, void *usr)

virtual void	addArealObjectRemovalCallback (DtArealObjectCallbackFunction cb, void *usr)
	"Areal Object Removed" callback registration/deregistration. More...

virtual void	removeArealObjectRemovalCallback (DtArealObjectCallbackFunction cb, void *usr)

virtual void	print () const
	Print the SRs of all reflected Areal Object. More...

virtual void	printDataToStream (std::ostream &stream) const
	Print the SRs to a stream. More...

Public Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (DtExerciseConn *exConn, int numBucketsPrimeNumber=503)
	Constructor. More...

virtual	~DtReflectedObjectList ()
	destructor Warning: makes non-virtual call to removeAndDelete More...

virtual void	initializeAttributePduKindsOfInterest (const std::set< DtPduKind > &pduKinds)
	This initializes which PDU kinds will be processed when receiving an Attribute PDU. More...

virtual DtReflectedObject *	firstObj () const
	Get the first/last object in the list. More...

virtual DtReflectedObject *	lastObj () const

virtual int	count () const
	Get number of objects. More...

virtual DtReflectedObject *	lookupObj (const DtBaseHashKey &key) const
	Search for an object. More...

virtual DtExerciseConn *	exerciseConn () const
	Get my exerciseConn. More...

virtual void	addObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object added callback registration/deregistration. More...

virtual void	removeObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)

virtual void	addObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object removed callback registration/deregistration. More...

virtual void	removeObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)

virtual void	setTimeoutProcessing (bool onOff)
	Set whether or not timeout processing occurs. More...

virtual void	setTimeoutInterval (DtTime time)
	Set/Get the remote object timeout period. More...

virtual DtTime	timeoutInterval ()

virtual void	setDiscoveryCondition (DtDiscoveryCondition fn, void *usr)
	Set the checker function which will determine when an object gets discovered and put into the ref. More...

virtual void	clearDiscoveryCondition ()
	Unregisters the checker function set in setDiscoverCondition. More...

virtual void	removeObject (DtReflectedObject *obj)
	This is the same as removeAndDelete, it exists to maintain equality with HLA objects. More...

virtual DtTime	timeoutCheckInterval () const

virtual void	setTimeoutCheckInterval (DtTime interval)

virtual void	addWaitlistAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Callback registration for when objects are added or removed from the waitlist. More...

virtual void	removeWaitlistAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)

virtual void	addWaitlistRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Waitlist removed callback registration/deregistration. More...

virtual void	removeWaitlistRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)

Protected Member Functions
virtual DtReflectedObject *	newReflectedObj (const DtStateMsg &msg)
	Overrides the base class implementation. Always returns NULL. More...

virtual DtReflectedArealObject *	newReflectedArealObject (const DtEntityIdentifier &id)
	Creates a new reflected Areal Object. More...

virtual int	acceptPdu (const DtStateMsg &msg) const
	Overrides the base class implementation. More...

virtual DtReflectedObject *	processStateMessage (const DtStateMsg &msg)
	Overrides the base class implementation. Processes a Areal Object Pdu. More...

virtual void	removeAndDelete (DtReflectedObject obj, const char msg=0)
	Print message 'msg' and execute the registered "ObjectRemoval" callbacks. More...

virtual void	objectAdded (DtReflectedObject *obj)
	Called after a reflected areal object is added to the list and before addition callbacks are processed. More...

const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *)
	Overrides the base class implementation. More...

	DtReflectedArealObjectList (const DtReflectedArealObjectList &)
	Copy constructor – Not Implemented. More...

DtReflectedArealObjectList &	operator= (const DtReflectedArealObjectList &)
	Assignment operator – Not Implemented. More...

Protected Member Functions inherited from DtReflectedObjectList
virtual void	doTimeouts ()
	Remove any remote objects which have not been updated during the timeout period. More...

virtual bool	shouldBeTimedOut (DtReflectedObject *object)
	Returns whether or not the object should be timed out. More...

void	emptyLists ()
	Empty the object list and the timeout list. More...

void	emptyCallbackLists ()

virtual void	processObjectAdditionCallbacks (DtReflectedObject *object)
	Process object addition/removal callbacks. More...

virtual void	processObjectRemovalCallbacks (DtReflectedObject *object)

virtual void	processWaitlistAdditionCallbacks (DtReflectedObject *object)
	Process waitlist addition/removal callbacks. More...

virtual void	processWaitlistRemovalCallbacks (DtReflectedObject *object)

virtual DtBaseHashKey *	hashKeyFromAttributeRecordSet (const DtAttributeRecordSet &recordSet)
	Get a hash key from an attribute record set. More...

virtual bool	readyToAdd (DtReflectedObject *obj)
	Returns true if the obj is ready to be added to myObjectList; calls myDiscoveryCondition from within. More...

virtual void	processAttributePduCb (DtAttributeInteraction *inter)

virtual void	processAttributePduRecordSet (const DtAttributeRecordSet &recordSet, const DtSimulationAddress &simAddr, DtReflectedObject *obj=0)

virtual void	processAttributePduWaitListCb (DtReflectedObject *obj)

virtual void	deleteRecordSetBySimulationAddressMap (DtRecordSetBySimulationAddressMap &recordSetMap, const DtSimulationAddress &simAddr=DtSimulationAddress()) const

Static Protected Member Functions
static void	arealObjectCb (DtArealObjectStatePdu pdu, void usr)
	Callback for the exercise connection. More...

Static Protected Member Functions inherited from DtReflectedObjectList
static void	doTimeoutsPostDrainCb (void *usr)
	Calls doTimeouts. More...

static void	processAttributePduCb (DtAttributeInteraction inter, void usr)

static void	processAttributePduWaitListCb (DtReflectedObject obj, void userData)

Detailed Description

Instances of this class provide a protocol independent interface to a list of reflected Areal Objects in a DIS environment.

Constructor & Destructor Documentation

DtReflectedArealObjectList::DtReflectedArealObjectList	(	DtExerciseConn *	exConn,
		int	numBucketsPrimeNumber = `503`
	)

CTOR.

virtual DtReflectedArealObjectList::~DtReflectedArealObjectList ( )

virtual

Virtual DTOR.

DtReflectedArealObjectList::DtReflectedArealObjectList ( const DtReflectedArealObjectList & )

protected

Copy constructor – Not Implemented.

Member Function Documentation

virtual int DtReflectedArealObjectList::acceptPdu ( const DtStateMsg & msg ) const

protectedvirtual

Overrides the base class implementation.

Determines if a PDU should be processed or not. Always returns 1.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedArealObjectList::addArealObjectAdditionCallback	(	DtArealObjectCallbackFunction	cb,
		void *	usr
	)

virtual

"Areal Object Added" callback registration/deregistration.

virtual void DtReflectedArealObjectList::addArealObjectRemovalCallback	(	DtArealObjectCallbackFunction	cb,
		void *	usr
	)

virtual

"Areal Object Removed" callback registration/deregistration.

static void DtReflectedArealObjectList::arealObjectCb	(	DtArealObjectStatePdu *	pdu,
		void *	usr
	)

staticprotected

Callback for the exercise connection.

virtual DtReflectedArealObject* DtReflectedArealObjectList::first ( ) const

virtual

Get the first and last elements of the reflected Areal Object's list.

const DtBaseHashKey& DtReflectedArealObjectList::hashKeyFromStateMessage ( const DtStateMsg * )

protectedvirtual

Overrides the base class implementation.

Generates a corresponding key from a Areal Object Pdu. Returns an instance of 'DtEventIdHashKey'. Note: the instance of the generated key is valid only until the next call to this method, or until the class instance itself goes out of scope (whichever is shorter).

Implements DtReflectedObjectList.

virtual DtReflectedArealObject* DtReflectedArealObjectList::last ( ) const

virtual

virtual DtReflectedArealObject* DtReflectedArealObjectList::lookup ( const DtEntityIdentifier & id ) const

virtual

Lookup a Areal Object from the Event ID.

virtual DtReflectedArealObject* DtReflectedArealObjectList::newReflectedArealObject ( const DtEntityIdentifier & id )

protectedvirtual

Creates a new reflected Areal Object.

Called by processStateMessage(). Override this to change the creation of new DtReflectedArealObjects.

virtual DtReflectedObject* DtReflectedArealObjectList::newReflectedObj ( const DtStateMsg & msg )

protectedvirtual

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual void DtReflectedArealObjectList::objectAdded ( DtReflectedObject * obj )

protectedvirtual

Called after a reflected areal object is added to the list and before addition callbacks are processed.

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedArealObjectList& DtReflectedArealObjectList::operator= ( const DtReflectedArealObjectList & )

protected

Assignment operator – Not Implemented.

virtual void DtReflectedArealObjectList::print ( ) const

virtual

Print the SRs of all reflected Areal Object.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedArealObjectList::printDataToStream ( std::ostream & stream ) const

virtual

Print the SRs to a stream.

virtual DtReflectedObject* DtReflectedArealObjectList::processStateMessage ( const DtStateMsg & msg )

protectedvirtual

Overrides the base class implementation. Processes a Areal Object Pdu.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedArealObjectList::removeAndDelete	(	DtReflectedObject *	obj,
		const char *	msg = `0`
	)

protectedvirtual

Print message 'msg' and execute the registered "ObjectRemoval" callbacks.

Remove reflected object 'obj' from the "reflected areal object" list. Note: Overrides the base class implementation

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedArealObjectList::removeArealObjectAdditionCallback	(	DtArealObjectCallbackFunction	cb,
		void *	usr
	)

virtual

virtual void DtReflectedArealObjectList::removeArealObjectRemovalCallback	(	DtArealObjectCallbackFunction	cb,
		void *	usr
	)

virtual

Member Data Documentation

DtEntityIdentifierHashKey DtReflectedArealObjectList::myHashKey

protected

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

reflectedArealObjectListDIS.h

Protected Attributes
DtEntityIdentifierHashKey	myHashKey

Protected Attributes inherited from DtReflectedObjectList
DtExerciseConn *	myExConn

DtIntrusiveList	myObjectAddedCallbacks

DtIntrusiveList	myObjectRemovedCallbacks

DtIntrusiveList	myWaitlistAddedCallbacks

DtIntrusiveList	myWaitlistRemovedCallbacks

DtIntrusiveList	myObjectList

DtIntrusiveList	myWaitList

DtHashlist	myObjectHashlist

DtHashlist	myWaitHashlist

DtAttributesByObjectIdMap	myAttributeWaitHashlist

DtTime	myTimeoutInterval

DtTime	myNextTimeoutCheck

DtTime	myTimeoutCheckInterval

bool	myTimeoutProcessingFlag

DtDiscoveryCondition	myDiscoveryCondition

void *	myDiscoveryConditionParameter

std::set< DtPduKind >	myPduKindSet

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation