DtReflectedPointObjectList Class Reference

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

Inheritance diagram for DtReflectedPointObjectList:

Collaboration diagram for DtReflectedPointObjectList:

Public Member Functions
	DtReflectedPointObjectList (DtExerciseConn *exConn)
	CTOR.
virtual	~DtReflectedPointObjectList ()
	Virtual DTOR.
virtual DtReflectedPointObject *	lookup (const DtEntityIdentifier &id) const
	Lookup a Point Object from the Event ID.
virtual DtReflectedPointObject *	first () const
	Get the first and last elements of the reflected Point Object's list.
virtual DtReflectedPointObject *	last () const
virtual void	addPointObjectAdditionCallback (DtPointObjectCallbackFunction cb, void *usr)
	"Point Object Added" callback registration/deregistration.
virtual void	removePointObjectAdditionCallback (DtPointObjectCallbackFunction cb, void *usr)
virtual void	addPointObjectRemovalCallback (DtPointObjectCallbackFunction cb, void *usr)
	"Point Object Removed" callback registration/deregistration.
virtual void	removePointObjectRemovalCallback (DtPointObjectCallbackFunction cb, void *usr)
virtual void	print () const
	Print the SRs of all reflected Point Object.
virtual void	printDataToStream (std::ostream &stream) const
	Print the SRs to a stream.
Public Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (DtExerciseConn *exConn)
	Constructor.
virtual	~DtReflectedObjectList ()
	destructor Warning: makes non-virtual call to removeAndDelete
virtual void	initializeAttributePduKindsOfInterest (const std::set< DtPduKind > &pduKinds)
	This initializes which PDU kinds will be processed when receiving an Attribute PDU.
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 DtReflectedObject *	lookupObj (const DtBaseHashKey &key) const
	Search for an object.
virtual DtExerciseConn *	exerciseConn () const
	Get my exerciseConn.
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	setTimeoutProcessing (bool onOff)
	Set whether or not timeout processing occurs.
virtual void	setTimeoutInterval (DtTime time)
	Set/Get the remote object timeout period.
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.
virtual void	clearDiscoveryCondition ()
	Unregisters the checker function set in setDiscoverCondition.

Protected Member Functions
virtual DtReflectedObject *	newReflectedObj (const DtStateMsg &msg)
	Overrides the base class implementation. Always returns NULL.
virtual DtReflectedPointObject *	newReflectedPointObject (const DtEntityIdentifier &id)
	Creates a new reflected Point Object.
virtual int	acceptPdu (const DtStateMsg &msg) const
	Overrides the base class implementation.
virtual DtReflectedObject *	processStateMessage (const DtStateMsg &msg)
	Overrides the base class implementation. Processes a Point Object Pdu.
virtual void	removeAndDelete (DtReflectedObject *obj, char *msg=0)
	Print message 'msg' and execute the registered "ObjectRemoval" callbacks.
virtual void	objectAdded (DtReflectedObject *obj)
	Called after a reflected point object is added to the list and before addition callbacks are processed.
const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *)
	Overrides the base class implementation.
	DtReflectedPointObjectList (const DtReflectedPointObjectList &)
	Copy constructor – Not Implemented.
DtReflectedPointObjectList &	operator= (const DtReflectedPointObjectList &)
	Assignment operator – Not Implemented.
Protected Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (const DtReflectedObjectList &orig)
	copy constructor – not implemented
DtReflectedObjectList &	operator= (const DtReflectedObjectList &orig)
	assignment operator – not implemented
virtual void	doTimeouts ()
	Remove any remote objects which have not been updated during the timeout period.
virtual bool	shouldBeTimedOut (DtReflectedObject *object)
	Returns whether or not the object should be timed out.
void	emptyLists ()
	Empty the object list and the timeout list.
void	emptyCallbackLists ()
virtual void	processObjectAdditionCallbacks (DtReflectedObject *object)
	Process object addition/removal callbacks.
virtual void	processObjectRemovalCallbacks (DtReflectedObject *object)
virtual DtBaseHashKey *	hashKeyFromAttributeRecordSet (const DtAttributeRecordSet &recordSet)
	Get a hash key from an attribute record set.
virtual bool	readyToAdd (DtReflectedObject *obj)
	Returns true if the obj is ready to be added to myObjectList; calls myDiscoveryCondition from within.
virtual void	processAttributePduCb (DtAttributeInteraction *inter)

Static Protected Member Functions
static void	pointObjectCb (DtPointObjectStatePdu *pdu, void *usr)
	Callback for the exercise connection.
Static Protected Member Functions inherited from DtReflectedObjectList
static void	doTimeoutsPostDrainCb (void *usr)
	Calls doTimeouts.
static void	processAttributePduCb (DtAttributeInteraction *inter, void *usr)

Protected Attributes
DtEntityIdentifierHashKey *	myHashKey
Protected Attributes inherited from DtReflectedObjectList
DtExerciseConn *	myExConn
DtIntrusiveList	myObjectAddedCallbacks
DtIntrusiveList	myObjectRemovedCallbacks
DtIntrusiveList	myObjectList
DtIntrusiveList	myWaitList
DtHashlist	myObjectHashlist
DtHashlist	myWaitHashlist
DtTime	myTimeoutInterval
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 Point Objects in a DIS environment.

Constructor & Destructor Documentation

DtReflectedPointObjectList::DtReflectedPointObjectList

(

DtExerciseConn *

exConn

)

CTOR.

virtual DtReflectedPointObjectList::~DtReflectedPointObjectList ( )

virtual

Virtual DTOR.

DtReflectedPointObjectList::DtReflectedPointObjectList ( const DtReflectedPointObjectList &  )

protected

Copy constructor – Not Implemented.

Member Function Documentation

virtual int DtReflectedPointObjectList::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 DtReflectedPointObjectList::addPointObjectAdditionCallback ( DtPointObjectCallbackFunction  cb, void *  usr  )

virtual

"Point Object Added" callback registration/deregistration.

virtual void DtReflectedPointObjectList::addPointObjectRemovalCallback ( DtPointObjectCallbackFunction  cb, void *  usr  )

virtual

"Point Object Removed" callback registration/deregistration.

virtual DtReflectedPointObject* DtReflectedPointObjectList::first ( ) const

virtual

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

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

protectedvirtual

Overrides the base class implementation.

Generates a corresponding key from a Point 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 DtReflectedPointObject* DtReflectedPointObjectList::last ( ) const

virtual

virtual DtReflectedPointObject* DtReflectedPointObjectList::lookup ( const DtEntityIdentifier &  id ) const

virtual

Lookup a Point Object from the Event ID.

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

protectedvirtual

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual DtReflectedPointObject* DtReflectedPointObjectList::newReflectedPointObject ( const DtEntityIdentifier &  id )

protectedvirtual

Creates a new reflected Point Object.

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

virtual void DtReflectedPointObjectList::objectAdded ( DtReflectedObject *  obj )

protectedvirtual

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

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedPointObjectList& DtReflectedPointObjectList::operator= ( const DtReflectedPointObjectList &  )

protected

Assignment operator – Not Implemented.

static void DtReflectedPointObjectList::pointObjectCb ( DtPointObjectStatePdu *  pdu, void *  usr  )

staticprotected

Callback for the exercise connection.

virtual void DtReflectedPointObjectList::print ( ) const

virtual

Print the SRs of all reflected Point Object.

Reimplemented from DtReflectedObjectList.

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

virtual

Print the SRs to a stream.

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

protectedvirtual

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

Reimplemented from DtReflectedObjectList.

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

protectedvirtual

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

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

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedPointObjectList::removePointObjectAdditionCallback ( DtPointObjectCallbackFunction  cb, void *  usr  )

virtual

virtual void DtReflectedPointObjectList::removePointObjectRemovalCallback ( DtPointObjectCallbackFunction  cb, void *  usr  )

virtual

Member Data Documentation

DtEntityIdentifierHashKey* DtReflectedPointObjectList::myHashKey

protected

---

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

• reflectedPointObjectListDIS.h