DtReflectedPropulsionNoiseList Class Reference

Instances of this class provide a protocol independent interface to a list of reflected propulsion noise objects in a DIS environment. More...

Inheritance diagram for DtReflectedPropulsionNoiseList:

Collaboration diagram for DtReflectedPropulsionNoiseList:

Public Member Functions
	DtReflectedPropulsionNoiseList (DtExerciseConn *exConn)
	Constructor.
virtual	~DtReflectedPropulsionNoiseList ()
	Destructor.
virtual DtReflectedPropulsionNoise *	lookup (const DtGlobalObjectDesignator &hostEntity) const
	Lookup a propulsion noise object from its object ID and system ID.
virtual DtReflectedPropulsionNoise *	first () const
	Get the first and last elements of the propulsion noise list.
virtual DtReflectedPropulsionNoise *	last () const
virtual void	addPropulsionNoiseAdditionCallback (DtPropNoiseCallbackFunction cb, void *userData)
	Propulsion noise object added callback registration/deregistration.
virtual void	removePropulsionNoiseAdditionCallback (DtPropNoiseCallbackFunction cb, void *userData)
virtual void	addPropulsionNoiseRemovalCallback (DtPropNoiseCallbackFunction cb, void *userData)
	Propulsion noise object removed callback registration/deregistration.
virtual void	removePropulsionNoiseRemovalCallback (DtPropNoiseCallbackFunction cb, void *userData)
virtual void	print () const
	Print the SRs of all objects.
virtual void	printDataToStream (std::ostream &stream) const
	Print the SR 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 *	newReflectedPropulsionNoise (const DtGlobalObjectDesignator &hostEntity)
	Create a new object from a host entity.
virtual DtReflectedObject *	newReflectedObj (const DtStateMsg &msg)
	Creates a a new object. Calls newReflectedPropulsionNoise to do so.
virtual int	acceptPdu (const DtStateMsg &msg) const
	Overrides the base class implementation.
virtual void	objectAdded (DtReflectedObject *obj)
	Called after an entity is added and before addition callbacks are processed.
virtual const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *msg)
	Get a hash key from a state message.
	DtReflectedPropulsionNoiseList (const DtReflectedPropulsionNoiseList &orig)
	Copy constructor – Not implemented.
DtReflectedPropulsionNoiseList &	operator= (const DtReflectedPropulsionNoiseList &orig)
	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 DtReflectedObject *	processStateMessage (const DtStateMsg &msg)
	Process an incoming state message.
virtual void	doTimeouts ()
	Remove any remote objects which have not been updated during the timeout period.
virtual void	removeAndDelete (DtReflectedObject *obj, char *msg=NULL)
	Remove the remote object from the list if found and delete it.
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)

Protected Attributes
DtObjectIdHashKey *	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 propulsion noise objects in a DIS environment.

Constructor & Destructor Documentation

DtReflectedPropulsionNoiseList::DtReflectedPropulsionNoiseList

(

DtExerciseConn *

exConn

)

Constructor.

virtual DtReflectedPropulsionNoiseList::~DtReflectedPropulsionNoiseList ( )

virtual

Destructor.

DtReflectedPropulsionNoiseList::DtReflectedPropulsionNoiseList ( const DtReflectedPropulsionNoiseList &  orig )

protected

Copy constructor – Not implemented.

Member Function Documentation

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

protectedvirtual

Overrides the base class implementation.

Determines if a PDU should be processed or not. Returns true if the given msg contains propulsion noise to be discovered.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedPropulsionNoiseList::addPropulsionNoiseAdditionCallback ( DtPropNoiseCallbackFunction  cb, void *  userData  )

virtual

Propulsion noise object added callback registration/deregistration.

virtual void DtReflectedPropulsionNoiseList::addPropulsionNoiseRemovalCallback ( DtPropNoiseCallbackFunction  cb, void *  userData  )

virtual

Propulsion noise object removed callback registration/deregistration.

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoiseList::first ( ) const

virtual

Get the first and last elements of the propulsion noise list.

virtual const DtBaseHashKey& DtReflectedPropulsionNoiseList::hashKeyFromStateMessage ( const DtStateMsg *  msg )

protectedvirtual

Get a hash key from a state message.

Implements DtReflectedObjectList.

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoiseList::last ( ) const

virtual

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoiseList::lookup ( const DtGlobalObjectDesignator &  hostEntity ) const

virtual

Lookup a propulsion noise object from its object ID and system ID.

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

protectedvirtual

Creates a a new object. Calls newReflectedPropulsionNoise to do so.

Implements DtReflectedObjectList.

virtual DtReflectedObject* DtReflectedPropulsionNoiseList::newReflectedPropulsionNoise ( const DtGlobalObjectDesignator &  hostEntity )

protectedvirtual

Create a new object from a host entity.

virtual void DtReflectedPropulsionNoiseList::objectAdded ( DtReflectedObject *  obj )

protectedvirtual

Called after an entity is added and before addition callbacks are processed.

Right now, this function only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedPropulsionNoiseList& DtReflectedPropulsionNoiseList::operator= ( const DtReflectedPropulsionNoiseList &  orig )

protected

Assignment operator – Not implemented.

virtual void DtReflectedPropulsionNoiseList::print ( ) const

virtual

Print the SRs of all objects.

Reimplemented from DtReflectedObjectList.

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

virtual

Print the SR to a stream.

virtual void DtReflectedPropulsionNoiseList::removePropulsionNoiseAdditionCallback ( DtPropNoiseCallbackFunction  cb, void *  userData  )

virtual

virtual void DtReflectedPropulsionNoiseList::removePropulsionNoiseRemovalCallback ( DtPropNoiseCallbackFunction  cb, void *  userData  )

virtual

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

staticprotected

Callback for the exercise connection.

Member Data Documentation

DtObjectIdHashKey* DtReflectedPropulsionNoiseList::myHashKey

protected

---

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

• reflectedPropulsionNoiseListDIS.h