DtReflectedLinearObjectList Class Reference

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

Inheritance diagram for DtReflectedLinearObjectList:

Collaboration diagram for DtReflectedLinearObjectList:

Public Member Functions
	DtReflectedLinearObjectList (DtExerciseConn *exConn, int numBucketsPrimeNumber=503)
	CTOR. More...
virtual	~DtReflectedLinearObjectList ()
	Virtual DTOR. More...
virtual DtReflectedLinearObject *	lookup (const DtEntityIdentifier &id) const
	Lookup a Linear Object from the Event ID. More...
virtual DtReflectedLinearObject *	first () const
	Get the first and last elements of the reflected Linear Object's list. More...
virtual DtReflectedLinearObject *	last () const
virtual void	addLinearObjectAdditionCallback (DtLinearObjectCallbackFunction cb, void *usr)
	"Linear Object Added" callback registration/deregistration. More...
virtual void	removeLinearObjectAdditionCallback (DtLinearObjectCallbackFunction cb, void *usr)
virtual void	addLinearObjectRemovalCallback (DtLinearObjectCallbackFunction cb, void *usr)
	"Linear Object Removed" callback registration/deregistration. More...
virtual void	removeLinearObjectRemovalCallback (DtLinearObjectCallbackFunction cb, void *usr)
virtual void	print () const
	Print the SRs of all reflected Linear 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 DtReflectedLinearObject *	newReflectedLinearObject (const DtEntityIdentifier &id)
	Creates a new reflected Linear 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 Linear 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 linear object is added to the list and before addition callbacks are processed. More...
const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *)
	Overrides the base class implementation. More...
	DtReflectedLinearObjectList (const DtReflectedLinearObjectList &)
	Copy constructor – Not Implemented. More...
DtReflectedLinearObjectList &	operator= (const DtReflectedLinearObjectList &)
	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	linearObjectCb (DtLinearObjectStatePdu *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)

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

Detailed Description

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

Constructor & Destructor Documentation

DtReflectedLinearObjectList::DtReflectedLinearObjectList	(	DtExerciseConn *	exConn,
		int	numBucketsPrimeNumber = 503
	)

CTOR.

virtual DtReflectedLinearObjectList::~DtReflectedLinearObjectList ( )

virtual

Virtual DTOR.

DtReflectedLinearObjectList::DtReflectedLinearObjectList ( const DtReflectedLinearObjectList &  )

protected

Copy constructor – Not Implemented.

Member Function Documentation

virtual int DtReflectedLinearObjectList::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 DtReflectedLinearObjectList::addLinearObjectAdditionCallback ( DtLinearObjectCallbackFunction  cb, void *  usr  )

virtual

"Linear Object Added" callback registration/deregistration.

virtual void DtReflectedLinearObjectList::addLinearObjectRemovalCallback ( DtLinearObjectCallbackFunction  cb, void *  usr  )

virtual

"Linear Object Removed" callback registration/deregistration.

virtual DtReflectedLinearObject* DtReflectedLinearObjectList::first ( ) const

virtual

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

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

protectedvirtual

Overrides the base class implementation.

Generates a corresponding key from a Linear 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 DtReflectedLinearObject* DtReflectedLinearObjectList::last ( ) const

virtual

static void DtReflectedLinearObjectList::linearObjectCb ( DtLinearObjectStatePdu *  pdu, void *  usr  )

staticprotected

Callback for the exercise connection.

virtual DtReflectedLinearObject* DtReflectedLinearObjectList::lookup ( const DtEntityIdentifier &  id ) const

virtual

Lookup a Linear Object from the Event ID.

virtual DtReflectedLinearObject* DtReflectedLinearObjectList::newReflectedLinearObject ( const DtEntityIdentifier &  id )

protectedvirtual

Creates a new reflected Linear Object.

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

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

protectedvirtual

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual void DtReflectedLinearObjectList::objectAdded ( DtReflectedObject *  obj )

protectedvirtual

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

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedLinearObjectList& DtReflectedLinearObjectList::operator= ( const DtReflectedLinearObjectList &  )

protected

Assignment operator – Not Implemented.

virtual void DtReflectedLinearObjectList::print ( ) const

virtual

Print the SRs of all reflected Linear Object.

Reimplemented from DtReflectedObjectList.

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

virtual

Print the SRs to a stream.

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

protectedvirtual

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

Reimplemented from DtReflectedObjectList.

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

protectedvirtual

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

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

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedLinearObjectList::removeLinearObjectAdditionCallback ( DtLinearObjectCallbackFunction  cb, void *  usr  )

virtual

virtual void DtReflectedLinearObjectList::removeLinearObjectRemovalCallback ( DtLinearObjectCallbackFunction  cb, void *  usr  )

virtual

Member Data Documentation

DtEntityIdentifierHashKey DtReflectedLinearObjectList::myHashKey

protected

---

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

• reflectedLinearObjectListDIS.h