DtReflectedActiveSonarList 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 DtReflectedActiveSonarList:

Collaboration diagram for DtReflectedActiveSonarList:

Public Member Functions
	DtReflectedActiveSonarList (DtExerciseConn *exConn)
	Constructor.
virtual	~DtReflectedActiveSonarList ()
	Destructor.
virtual DtReflectedActiveSonar *	lookup (const DtGlobalObjectDesignator &hostEntity, int acousticId) const
	Lookup an active sonar from the object ID of its designating entity and its acoustic identifier.
virtual DtReflectedActiveSonar *	first () const
	Get the first and last elements of the reflected active sonar list.
virtual DtReflectedActiveSonar *	last () const
virtual void	addActiveSonarAdditionCallback (DtActiveSonarCallbackFunction cb, void *userData)
	Active Sonar addition callback registration/deregistration.
virtual void	removeActiveSonarAdditionCallback (DtActiveSonarCallbackFunction cb, void *userData)
virtual void	addActiveSonarRemovalCallback (DtActiveSonarCallbackFunction cb, void *userData)
	Active Sonar remove callback registration/deregistration.
virtual void	removeActiveSonarRemovalCallback (DtActiveSonarCallbackFunction cb, void *userData)
virtual void	print () const
	Print the SRs of all reflected active sonar.
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 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 DtReflectedActiveSonar *	newReflectedActiveSonar (const DtEntityIdentifier &hostEntity, int acousticId)
	Creates a new reflected active sonar.
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 active sonar is added to the list and before addition callbacks are processed.
const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *)
	Overrides the base class implementation.
	DtReflectedActiveSonarList (const DtReflectedActiveSonarList &)
	Copy constructor – Not Implemented.
DtReflectedActiveSonarList &	operator= (const DtReflectedActiveSonarList &)
	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 bool	readyToAdd (DtReflectedObject *obj)
	Returns true if the obj is ready to be added to myObjectList; calls myDiscoveryCondition from within.

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.

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

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

DtReflectedActiveSonarList::DtReflectedActiveSonarList

(

DtExerciseConn *

exConn

)

Constructor.

virtual DtReflectedActiveSonarList::~DtReflectedActiveSonarList ( )

virtual

Destructor.

DtReflectedActiveSonarList::DtReflectedActiveSonarList ( const DtReflectedActiveSonarList &  )

protected

Copy constructor – Not Implemented.

Member Function Documentation

virtual int DtReflectedActiveSonarList::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 DtReflectedActiveSonarList::addActiveSonarAdditionCallback ( DtActiveSonarCallbackFunction  cb, void *  userData  )

virtual

Active Sonar addition callback registration/deregistration.

virtual void DtReflectedActiveSonarList::addActiveSonarRemovalCallback ( DtActiveSonarCallbackFunction  cb, void *  userData  )

virtual

Active Sonar remove callback registration/deregistration.

virtual DtReflectedActiveSonar* DtReflectedActiveSonarList::first ( ) const

virtual

Get the first and last elements of the reflected active sonar list.

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

protectedvirtual

Overrides the base class implementation.

Generates a corresponding key from a 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 DtReflectedActiveSonar* DtReflectedActiveSonarList::last ( ) const

virtual

virtual DtReflectedActiveSonar* DtReflectedActiveSonarList::lookup ( const DtGlobalObjectDesignator &  hostEntity, int  acousticId  ) const

virtual

Lookup an active sonar from the object ID of its designating entity and its acoustic identifier.

virtual DtReflectedActiveSonar* DtReflectedActiveSonarList::newReflectedActiveSonar ( const DtEntityIdentifier &  hostEntity, int  acousticId  )

protectedvirtual

Creates a new reflected active sonar.

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

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

protectedvirtual

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual void DtReflectedActiveSonarList::objectAdded ( DtReflectedObject *  obj )

protectedvirtual

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

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedActiveSonarList& DtReflectedActiveSonarList::operator= ( const DtReflectedActiveSonarList &  )

protected

Assignment operator – Not Implemented.

virtual void DtReflectedActiveSonarList::print ( ) const

virtual

Print the SRs of all reflected active sonar.

Reimplemented from DtReflectedObjectList.

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

virtual

Print the SRs to a stream.

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

protectedvirtual

Overrides the base class implementation.

Processes an Underwater Acoustic Pdu.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedActiveSonarList::removeActiveSonarAdditionCallback ( DtActiveSonarCallbackFunction  cb, void *  userData  )

virtual

virtual void DtReflectedActiveSonarList::removeActiveSonarRemovalCallback ( DtActiveSonarCallbackFunction  cb, void *  userData  )

virtual

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

protectedvirtual

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

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

Reimplemented from DtReflectedObjectList.

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

staticprotected

Callback for the exercise connection.

---

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

• dRefActSonarList.h