DtReflectedAdditionalPassiveActivitiesList Class Reference

Instances of this class provide a protocol independent interface to a list of additional passive activities in a DIS environment. More...

Inheritance diagram for DtReflectedAdditionalPassiveActivitiesList:

Collaboration diagram for DtReflectedAdditionalPassiveActivitiesList:

Public Member Functions
	DtReflectedAdditionalPassiveActivitiesList (DtExerciseConn *exConn)
	Constructor.
virtual	~DtReflectedAdditionalPassiveActivitiesList ()
	Destructor.
virtual DtReflectedAdditionalPassiveActivities *	lookup (const DtGlobalObjectDesignator &hostEntity, int activityCode) const
	Lookup an APA from the object ID of its host entity and its activity code.
virtual DtReflectedAdditionalPassiveActivities *	first () const
	Get the first and last elements of the reflected APA list.
virtual DtReflectedAdditionalPassiveActivities *	last () const
virtual void	addAdditionalPassiveActivitiesAdditionCallback (DtApaCallbackFunction cb, void *userData)
	"APA Added" callback registration/deregistration.
virtual void	removeAdditionalPassiveActivitiesAdditionCallback (DtApaCallbackFunction cb, void *userData)
virtual void	addAdditionalPassiveActivitiesRemovalCallback (DtApaCallbackFunction cb, void *userData)
	"APA Removed" callback registration/deregistration.
virtual void	removeAdditionalPassiveActivitiesRemovalCallback (DtApaCallbackFunction cb, void *userData)
virtual void	print () const
	Print the SRs of all reflected APAs.
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 DtReflectedObject *	newReflectedApa (const DtGlobalObjectDesignator &hostEntity, int activityCode)
	Creates a new reflected APA.
virtual int	acceptPdu (const DtStateMsg &msg) const
	Overrides the base class implementation.
virtual DtReflectedObject *	processStateMessage (const DtStateMsg &msg)
	Overrides the base class implementation.
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 APA is added to the list and before addition callbacks are processed.
const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *)
	Overrides the base class implementation.
	DtReflectedAdditionalPassiveActivitiesList (const DtReflectedAdditionalPassiveActivitiesList &)
	Copy constructor – Not Implemented.
DtReflectedAdditionalPassiveActivitiesList &	operator= (const DtReflectedAdditionalPassiveActivitiesList &)
	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	underwaterAcousticCb (DtUnderwaterAcousticPdu *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)

Additional Inherited Members
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 additional passive activities in a DIS environment.

Constructor & Destructor Documentation

DtReflectedAdditionalPassiveActivitiesList::DtReflectedAdditionalPassiveActivitiesList

(

DtExerciseConn *

exConn

)

Constructor.

virtual DtReflectedAdditionalPassiveActivitiesList::~DtReflectedAdditionalPassiveActivitiesList ( )

virtual

Destructor.

DtReflectedAdditionalPassiveActivitiesList::DtReflectedAdditionalPassiveActivitiesList ( const DtReflectedAdditionalPassiveActivitiesList &  )

protected

Copy constructor – Not Implemented.

Member Function Documentation

virtual int DtReflectedAdditionalPassiveActivitiesList::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 DtReflectedAdditionalPassiveActivitiesList::addAdditionalPassiveActivitiesAdditionCallback ( DtApaCallbackFunction  cb, void *  userData  )

virtual

"APA Added" callback registration/deregistration.

virtual void DtReflectedAdditionalPassiveActivitiesList::addAdditionalPassiveActivitiesRemovalCallback ( DtApaCallbackFunction  cb, void *  userData  )

virtual

"APA Removed" callback registration/deregistration.

virtual DtReflectedAdditionalPassiveActivities* DtReflectedAdditionalPassiveActivitiesList::first ( ) const

virtual

Get the first and last elements of the reflected APA list.

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

protectedvirtual

Overrides the base class implementation.

Generates a corresponding key from an Underwater Acoustic PDU. Returns an instance of 'DtSystemHashKey'. 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 DtReflectedAdditionalPassiveActivities* DtReflectedAdditionalPassiveActivitiesList::last ( ) const

virtual

virtual DtReflectedAdditionalPassiveActivities* DtReflectedAdditionalPassiveActivitiesList::lookup ( const DtGlobalObjectDesignator &  hostEntity, int  activityCode  ) const

virtual

Lookup an APA from the object ID of its host entity and its activity code.

virtual DtReflectedObject* DtReflectedAdditionalPassiveActivitiesList::newReflectedApa ( const DtGlobalObjectDesignator &  hostEntity, int  activityCode  )

protectedvirtual

Creates a new reflected APA.

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

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

protectedvirtual

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual void DtReflectedAdditionalPassiveActivitiesList::objectAdded ( DtReflectedObject *  obj )

protectedvirtual

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

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedAdditionalPassiveActivitiesList& DtReflectedAdditionalPassiveActivitiesList::operator= ( const DtReflectedAdditionalPassiveActivitiesList &  )

protected

Assignment operator – Not Implemented.

virtual void DtReflectedAdditionalPassiveActivitiesList::print ( ) const

virtual

Print the SRs of all reflected APAs.

Reimplemented from DtReflectedObjectList.

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

virtual

Print the SRs to a stream.

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

protectedvirtual

Overrides the base class implementation.

Processes an Underwater Acoustic PDU.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedAdditionalPassiveActivitiesList::removeAdditionalPassiveActivitiesAdditionCallback ( DtApaCallbackFunction  cb, void *  userData  )

virtual

virtual void DtReflectedAdditionalPassiveActivitiesList::removeAdditionalPassiveActivitiesRemovalCallback ( DtApaCallbackFunction  cb, void *  userData  )

virtual

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

protectedvirtual

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

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

Reimplemented from DtReflectedObjectList.

static void DtReflectedAdditionalPassiveActivitiesList::underwaterAcousticCb ( DtUnderwaterAcousticPdu *  pdu, void *  usr  )

staticprotected

Callback for the exercise connection.

---

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

• reflectedAdditionalPassiveActivitiesListDIS.h