![]() |
VR-Link API Documentation for DIS
|
Instances of this class provide a protocol independent interface to a list of SubsurfaceLayer in a DIS environment. More...
Inheritance diagram for DtReflectedSubsurfaceLayerList:
Collaboration diagram for DtReflectedSubsurfaceLayerList:Public Member Functions | |
| DtReflectedSubsurfaceLayerList (DtExerciseConn *exConn) | |
| Constructor. More... | |
| virtual | ~DtReflectedSubsurfaceLayerList () |
| Destructor. More... | |
| virtual DtReflectedSubsurfaceLayer * | first () const |
| virtual DtReflectedSubsurfaceLayer * | last () const |
| virtual void | addSubsurfaceLayerAdditionCallback (DtSubsurfaceLayerCallbackFunction cb, void *userData) |
| SubsurfaceLayer added callback registration/deregistration. More... | |
| virtual void | removeSubsurfaceLayerAdditionCallback (DtSubsurfaceLayerCallbackFunction cb, void *userData) |
| virtual void | addSubsurfaceLayerRemovalCallback (DtSubsurfaceLayerCallbackFunction cb, void *userData) |
| SubsurfaceLayer removed callback registration/deregistration. More... | |
| virtual void | removeSubsurfaceLayerRemovalCallback (DtSubsurfaceLayerCallbackFunction cb, void *userData) |
| virtual void | print () |
| Print the SRs of all objects. More... | |
| virtual DtReflectedSubsurfaceLayer * | processSubsurfaceLayerState (const DtMetocPdu &pdu) |
| Process an incoming SubsurfaceLayer state pdu. 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 DtReflectedObject * | firstObj () const |
| Get the first/last object in the list. More... | |
| virtual DtReflectedObject * | lastObj () const |
| virtual int | count () const |
| Get number of objects. More... | |
| virtual DtReflectedObject * | lookupObj (const DtBaseHashKey &key) const |
| Search for an object. More... | |
| virtual DtExerciseConn * | exerciseConn () 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 | print () const |
| Print the SRs of all objects. More... | |
| 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, const 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) |
| virtual void | addWaitlistAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData) |
| Callback registration for when objects are added or removed from the waitlist. More... | |
| virtual void | removeWaitlistAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData) |
| virtual void | addWaitlistRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData) |
| Waitlist removed callback registration/deregistration. More... | |
| virtual void | removeWaitlistRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData) |
Protected Member Functions | |
| virtual DtReflectedObject * | newReflectedObj (const DtStateMsg &msg) |
| Create a new object from a state message. More... | |
| virtual DtReflectedObject * | processStateMessage (const DtStateMsg &msg) |
| Process an incoming state message. More... | |
| virtual void | objectAdded (DtReflectedObject *obj) |
| Called after an SubsurfaceLayer is added and before additional callbacks are processed. More... | |
| virtual int | acceptPdu (const DtStateMsg &msg) const |
| Determines if a PDU should be processed or not. More... | |
| virtual const DtBaseHashKey & | hashKeyFromStateMessage (const DtStateMsg *msg) |
| Get a hash key from a state message. More... | |
| virtual DtReflectedSubsurfaceLayer * | newReflectedSubsurfaceLayer () const |
| Create a new reflected SubsurfaceLayer. More... | |
| virtual void | subsurfaceLayerAdded (DtReflectedSubsurfaceLayer *agg) |
| Called after a SubsurfaceLayer is added and before additional callbacks are processed. More... | |
Protected Member Functions inherited from DtReflectedObjectList | |
| 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 void | processWaitlistAdditionCallbacks (DtReflectedObject *object) |
| Process waitlist addition/removal callbacks. More... | |
| virtual void | processWaitlistRemovalCallbacks (DtReflectedObject *object) |
| virtual DtBaseHashKey * | hashKeyFromAttributeRecordSet (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 | subsurfaceLayerStateCb (DtMetocPdu *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) |
Private Member Functions | |
| DtReflectedSubsurfaceLayerList & | operator= (const DtReflectedSubsurfaceLayerList &orig) |
| Assignment operator – not implemented. More... | |
| DtReflectedSubsurfaceLayerList (const DtReflectedSubsurfaceLayerList &orig) | |
| Copy constructor – not implemented. More... | |
Instances of this class provide a protocol independent interface to a list of SubsurfaceLayer in a DIS environment.
SubsurfaceLayer PDUs are used by VR-Forces to send weather area info to other applications. These SubsurfaceLayer objects have longer timeout and heartbeat values than other DIS objects. The default Timeout/Heartbeat times are 25 seconds and 10 seconds respectively.
| DtReflectedSubsurfaceLayerList::DtReflectedSubsurfaceLayerList | ( | DtExerciseConn * | exConn | ) |
Constructor.
|
virtual |
Destructor.
|
private |
Copy constructor – not implemented.
|
protectedvirtual |
Determines if a PDU should be processed or not.
Looks at the METOC Layer Record Type in the PDU for a SubsurfaceLayerRecord
Reimplemented from DtReflectedObjectList.
|
virtual |
SubsurfaceLayer added callback registration/deregistration.
|
virtual |
SubsurfaceLayer removed callback registration/deregistration.
|
virtual |
|
protectedvirtual |
Get a hash key from a state message.
Implements DtReflectedObjectList.
|
virtual |
|
protectedvirtual |
Create a new object from a state message.
Implements DtReflectedObjectList.
|
protectedvirtual |
Create a new reflected SubsurfaceLayer.
|
protectedvirtual |
Called after an SubsurfaceLayer is added and before additional callbacks are processed.
Right now, this function only calls DtInfo.
Reimplemented from DtReflectedObjectList.
|
private |
Assignment operator – not implemented.
|
virtual |
Print the SRs of all objects.
|
protectedvirtual |
Process an incoming state message.
Reimplemented from DtReflectedObjectList.
|
virtual |
Process an incoming SubsurfaceLayer state pdu.
Then calls down to base class processStateMessage().
|
virtual |
|
virtual |
|
protectedvirtual |
Called after a SubsurfaceLayer is added and before additional callbacks are processed.
Right now, this function only calls DtInfo.
|
staticprotected |
Callback for the exercise connection.
|
protected |