VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
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, int numBucketsPrimeNumber=503)
 Constructor. More...
 
virtual ~DtReflectedPropulsionNoiseList ()
 Destructor. More...
 
virtual
DtReflectedPropulsionNoise
lookup (const DtGlobalObjectDesignator &hostEntity) const
 Lookup a propulsion noise object from its object ID and system ID. More...
 
virtual
DtReflectedPropulsionNoise
first () const
 Get the first and last elements of the propulsion noise list. More...
 
virtual
DtReflectedPropulsionNoise
last () const
 
virtual void addPropulsionNoiseAdditionCallback (DtPropNoiseCallbackFunction cb, void *userData)
 Propulsion noise object added callback registration/deregistration. More...
 
virtual void removePropulsionNoiseAdditionCallback (DtPropNoiseCallbackFunction cb, void *userData)
 
virtual void addPropulsionNoiseRemovalCallback (DtPropNoiseCallbackFunction cb, void *userData)
 Propulsion noise object removed callback registration/deregistration. More...
 
virtual void removePropulsionNoiseRemovalCallback (DtPropNoiseCallbackFunction cb, void *userData)
 
virtual void print () const
 Print the SRs of all objects. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the SR 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 DtReflectedObjectfirstObj () const
 Get the first/last object in the list. More...
 
virtual DtReflectedObjectlastObj () const
 
virtual int count () const
 Get number of objects. More...
 
virtual DtReflectedObjectlookupObj (const DtBaseHashKey &key) const
 Search for an object. More...
 
virtual DtExerciseConnexerciseConn () 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 removeAndDelete (DtReflectedObject *obj, char *msg=NULL)
 Remove the remote object from the list if found and delete it. 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)
 

Protected Member Functions

virtual DtReflectedObjectnewReflectedPropulsionNoise (const DtGlobalObjectDesignator &hostEntity)
 Create a new object from a host entity. More...
 
virtual DtReflectedObjectnewReflectedObj (const DtStateMsg &msg)
 Creates a a new object. Calls newReflectedPropulsionNoise to do so. More...
 
virtual int acceptPdu (const DtStateMsg &msg) const
 Overrides the base class implementation. More...
 
virtual void objectAdded (DtReflectedObject *obj)
 Called after an entity is added and before addition callbacks are processed. More...
 
virtual const DtBaseHashKeyhashKeyFromStateMessage (const DtStateMsg *msg)
 Get a hash key from a state message. More...
 
 DtReflectedPropulsionNoiseList (const DtReflectedPropulsionNoiseList &orig)
 Copy constructor – Not implemented. More...
 
DtReflectedPropulsionNoiseListoperator= (const DtReflectedPropulsionNoiseList &orig)
 Assignment operator – Not implemented. More...
 
- Protected Member Functions inherited from DtReflectedObjectList
virtual DtReflectedObjectprocessStateMessage (const DtStateMsg &msg)
 Process an incoming state message. More...
 
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 DtBaseHashKeyhashKeyFromAttributeRecordSet (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 underwaterAcousticCb (DtUnderwaterAcousticPdu *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

DtObjectIdHashKey myHashKey
 
- Protected Attributes inherited from DtReflectedObjectList
DtExerciseConnmyExConn
 
DtIntrusiveList myObjectAddedCallbacks
 
DtIntrusiveList myObjectRemovedCallbacks
 
DtIntrusiveList myObjectList
 
DtIntrusiveList myWaitList
 
DtHashlist myObjectHashlist
 
DtHashlist myWaitHashlist
 
DtAttributesByObjectIdMap myAttributeWaitHashlist
 
DtTime myTimeoutInterval
 
DtTime myNextTimeoutCheck
 
DtTime myTimeoutCheckInterval
 
bool myTimeoutProcessingFlag
 
DtDiscoveryCondition myDiscoveryCondition
 
void * myDiscoveryConditionParameter
 
std::set< DtPduKindmyPduKindSet
 

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,
int  numBucketsPrimeNumber = 503 
)

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:

Document ID: Generated on Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)