 |
VR-Link API Documentation for HLA Evolved
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Link API Documentation for HLA Evolved
|
An instance of this class manages the list of "Test" objects that are simulated remotely, and reflected to us by the RTI. More...
Inheritance diagram for ReflectedTestList: Collaboration diagram for ReflectedTestList:Public Member Functions | |
| ReflectedTestList (DtExerciseConn *exConn) | |
| Constructor. More... | |
| virtual | ~ReflectedTestList () |
| destructor More... | |
| virtual ReflectedTest * | lookup (RTI::ObjectHandle id) |
| The following public functions are not required by VR-Link, but they are strongly recommended. More... | |
| virtual ReflectedTest * | lookup (const DtGlobalObjectDesignator &objName) |
| Look up object by name (global object designator). More... | |
| virtual ReflectedTest * | first () const |
| Get the first/last object in the list. More... | |
| virtual ReflectedTest * | last () const |
| virtual void | addTestAdditionCallback (TestCallbackFunction cb, void *userData) |
| Functions that allow a user to register callbacks that will be called when "Test" objects are added and removed from the list. More... | |
| virtual void | removeTestAdditionCallback (TestCallbackFunction cb, void *userData) |
| virtual void | addTestRemovalCallback (TestCallbackFunction cb, void *userData) |
| Registration/deregistration of object removal callbacks. More... | |
| virtual void | removeTestRemovalCallback (TestCallbackFunction cb, void *userData) |
| Public Member Functions inherited from DtReflectedObjectList | |
| DtReflectedObjectList (DtExerciseConn *exConn, const DtDDMRegionSet *regionSetToUse=0, const DtString &updateRateTag=DtString("")) | |
| Constructor. More... | |
| virtual | ~DtReflectedObjectList () |
| destructor More... | |
| virtual DtReflectedObject * | lookupObj (RTI::ObjectHandle id) |
| Look up object by identifier. More... | |
| virtual DtReflectedObject * | lookupObj (const DtGlobalObjectDesignator &objName) |
| Look up object by global ID (which is the object name in RTI1.3.3). More... | |
| virtual int | count () const |
| Get number of objects. More... | |
| virtual DtExerciseConn * | exerciseConn () const |
| Get my exerciseConn. More... | |
| virtual void | manageObjectClass (RTI::ObjectClassHandle handle) |
| Register callbacks with exercise connection so that we get notified when an object of this class is discovered. More... | |
| virtual bool | removeObject (const DtObjectId &id) |
| Have the application act as though we had never discovered the object. 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 () |
| Print the SRs of all objects. More... | |
| virtual void | printWaitList () |
| Print the SRs of all waiting objects (most likely will have mostly bad data). More... | |
| virtual void | setTimeoutProcessing (bool onOff) |
| Set whether or not timeout processing occurs. More... | |
| virtual bool | isTimeoutProcessing () const |
| Get whether or not timeout processing occurs. More... | |
| virtual bool | requestsEnabled () const |
| Get whether or not to process requests for reflected objects that were just discovered or are waiting for updates (to meet discovery criteria). More... | |
| virtual int | numberObjectsWaiting () const |
| Return the number of objects in the wait list. More... | |
| virtual void | checkDiscoveryConditionForWaitList () |
| Check discovery conditions for all items in wait list. More... | |
| virtual DtTime | nextRequestTime () const |
| Return the time when the next request will be made for entries in the wait refresh list. More... | |
| virtual void | setDiscoveryCondition (DtDiscoveryCondition fn, void *usr) |
| Set the checker function which will determine when an object gets discovered and put into the reflected list. More... | |
| virtual void | clearDiscoveryCondition () |
| Unregisters the checker function set in setDiscoverCondition. More... | |
| virtual const DtDDMRegionSet & | subscribedRegions () |
| Returns list of regions subscribed to. More... | |
| 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) |
| virtual DtReflectedObject * | firstObj () const |
| Get the first/last object in the list. More... | |
| virtual DtReflectedObject * | lastObj () const |
| Get the first/last object in the list. More... | |
| virtual void | setTimeoutInterval (DtTime time) |
| Set/Get the remote object timeout period. More... | |
| virtual DtTime | timeoutInterval () const |
| Set/Get the remote object timeout period. More... | |
| virtual void | setWaitListRefreshEnabled (bool on) |
| Set whether or not we will resend request updates for objects which remain on wait list because they have not met discovery criteria. More... | |
| virtual bool | waitListRefreshEnabled () const |
| Set whether or not we will resend request updates for objects which remain on wait list because they have not met discovery criteria. More... | |
| virtual void | setWaitListRefreshPeriod (DtTime period) |
| Set/Get the wait list refresh period. More... | |
| virtual DtTime | waitListRefreshPeriod () const |
| Set/Get the wait list refresh period. More... | |
| virtual DtReflectedObject * | firstWaitingObj () const |
| Get the first/last object in the wait list. More... | |
| virtual DtReflectedObject * | lastWaitingObj () const |
| Get the first/last object in the wait list. More... | |
Protected Member Functions | |
| virtual DtReflectedObject * | newReflectedObject (DtHlaObject *obj) const |
| Override of virtual function that the base class uses to create the appropriate kind of DtReflectedObject. More... | |
| Protected Member Functions inherited from DtReflectedObjectList | |
| virtual void | processDiscoverObject (DtHlaObject *obj) |
| Process the discovery of a remote object on the network. More... | |
| virtual void | processRemoveObject (DtHlaObject *obj) |
| Process the removal of a remote object from the network. More... | |
| virtual void | processTimedOutObjectReflect (const DtStateMsg &msg, DtHlaObject *obj) |
| Handle the receipt of attributes for a remote object which was timed out. More... | |
| virtual void | doTimeouts () |
| Remove any remote objects which have not been updated during the timeout period. More... | |
| virtual void | doRequestUpdates () |
| Request an update for discovered objects. More... | |
| virtual void | removeAndDelete (DtReflectedObject *obj, char *msg=nullptr) |
| Remove the remote object from the list if found and delete it. More... | |
| virtual void | objectAdded (DtReflectedObject *object) |
| Called from processDiscoverObject() after a remote object has been added to the list. More... | |
| virtual bool | shouldBeTimedOut (DtReflectedObject *object) |
| Returns whether or not the object should be timed out. More... | |
| virtual void | timeOutObject (DtReflectedObject *object) |
| Times out object by removing it from the remote object list and deleting it. More... | |
| virtual void | unTimeOutObject (DtHlaObject *obj) |
| Manages callbacks and data used for reinstating a remote object which was timed out. More... | |
| virtual void | addObjectClass (RTI::ObjectClassHandle handle) |
| Register interest in this FOM object class. More... | |
| virtual void | addObjectClassByName (const char *className) |
| Register interest in this FOM object class by className. More... | |
| virtual void | init (const DtList *handleList) |
| Register interest in a whole list of RTI::ObjectClassHandles all at once. More... | |
| void | emptyLists () |
| Empty the object list and the timeout list. More... | |
| void | emptyCallbackLists () |
| Empty the callback lists. More... | |
| 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 void | findAlreadyDiscoveredObjects () |
| When list is created, we call this function to go through the list of all discovered HLA objects to see if any should be managed by this list. More... | |
| virtual void | checkDiscoveryCondition (DtReflectedObject *refObj) |
| virtual bool | readyToAdd (DtReflectedObject *obj) |
| Returns true if the obj is ready to be added to myObjectList; calls myWaitListChecker from within. More... | |
| virtual void | addToObjectList (DtReflectedObject *refObj) |
| Add refObj to myObjectList and initiates discovery callbacks. More... | |
| virtual void | addToWaitList (DtReflectedObject *refObj) |
| Add refObj to wait list. More... | |
| virtual void | removeFromWaitList (DtReflectedObject *refObj) |
| Remove refObj from wait list. More... | |
| virtual void | addToRefreshList (DtReflectedObject *refObj, DtTime timeToRefresh) |
| Add refObj to refresh list. More... | |
| virtual DtReflectedObject * | lookupObjInWaitList (RTI::ObjectHandle id) |
| Find object in waitList by identifier. More... | |
| virtual DtReflectedObject * | lookupObjInWaitList (const DtGlobalObjectDesignator &name) |
| Find object in waitList by name. More... | |
| void | unsubscribeRegions () |
| const DtString & | updateRateSubscriptionName () const |
| Return the name of the update rate associated with our subscription, if any. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DtReflectedObjectList | |
| static bool | requestUpdateFlags () |
| Get flag that indicates if any requests are enabled (class, object, or initialized) More... | |
| static void | findDiscoveredObjectsCb (void *usr) |
| Post-drain callback that calls findAlreadyDiscovedObjects(). More... | |
| static void | setAutoSubscribeFlag (bool flag) |
| Set/Get flag which determines whether to subscribe to object classes that this list manages. More... | |
| static bool | autoSubscribeFlag () |
| Set/Get flag which determines whether to subscribe to object classes that this list manages. More... | |
| static void | setRequestClassUpdateFlag (bool onOff) |
| Set/Get flag that determines whether we request updates from all objects of the object classes we subscribe to. More... | |
| static bool | requestClassUpdateFlag () |
| Set/Get flag that determines whether we request updates from all objects of the object classes we subscribe to. More... | |
| static void | setRequestObjectUpdateFlag (bool onOff) |
| Set/Get flag that determines whether we request updates from an object as we discover it. More... | |
| static bool | requestObjectUpdateFlag () |
| Set/Get flag that determines whether we request updates from an object as we discover it. More... | |
| static void | setRequestWhenInitializedFlag (bool onOff) |
| Set/Get flag that determines whether we request updates for wait listed objects only when all known VRLStateObject instances are initialized. More... | |
| static bool | requestWhenInitializedFlag () |
| Set/Get flag that determines whether we request updates for wait listed objects only when all known VRLStateObject instances are initialized. More... | |
| static void | setDefaultWaitListRefreshFlag (bool onOff) |
| Set/Get the default wait list enabled flag value. More... | |
| static bool | defaultWaitListRefreshFlag () |
| Set/Get the default wait list enabled flag value. More... | |
| static void | setDefaultWaitListRefreshPeriod (DtTime period) |
| Set/Get the default wait list refresh period. More... | |
| static DtTime | defaultWaitListRefreshPeriod () |
| Set/Get the default wait list refresh period. More... | |
| Static Protected Member Functions inherited from DtReflectedObjectList | |
| static void | discoverObjectCb (DtHlaObject *hlaObj, void *rel) |
| Cast the void* to a DtReflectedObjectList* and calls processDiscoverObject(). More... | |
| static void | removeObjectCb (DtHlaObject *hlaObj, void *rel) |
| Cast the void* to a DtReflectedObjectList* and calls processRemoveObject(). More... | |
| static void | timedOutObjectReflectCb (const DtStateMsg &msg, DtHlaObject *obj, void *usr) |
| Cast the void* to a DtReflectedObjectList* and calls processTimedOutObjectReflect(). More... | |
| static void | doTimeoutsPostDrainCb (void *usr) |
| Calls doTimeouts. More... | |
| static void | doRequestUpdatesPostDrainCb (void *usr) |
| Calls doRequestUpdates. More... | |
| static void | postUpdateCb (DtReflectedObject *obj, void *usr) |
| Calls checkDiscoveryCondition. More... | |
| Protected Attributes inherited from DtReflectedObjectList | |
| DtExerciseConn * | myExConn |
| DtRefHlaObjectMap | myObjectList |
| DtHashList | myObjectListByName |
| DtRefHlaObjectMap | myWaitList |
| DtRefHlaObjectMap | myDiscoveryList |
| DtRefHlaObjectTimeMap | myRefreshList |
| bool | myWaitListRefreshEnabled |
| DtTime | myNextRequestTime |
| DtTime | myWaitListRefreshPeriod |
| DtList | myTimedOutObjectList |
| DtTime | myTimeoutInterval |
| bool | myTimeoutProcessingFlag |
| std::vector < RTI::ObjectClassHandle > | myHandleList |
| DtIntrusiveList | myObjectAddedCallbacks |
| DtIntrusiveList | myObjectRemovedCallbacks |
| DtIntrusiveList | myWaitlistAddedCallbacks |
| DtIntrusiveList | myWaitlistRemovedCallbacks |
| DtDiscoveryCondition | myDiscoveryCondition |
| void * | myDiscoveryConditionParameter |
| DtDDMRegionSet | mySubscribedRegions |
| DtString | myUpdateRateTag |
| Static Protected Attributes inherited from DtReflectedObjectList | |
| static bool | theAutoSubscribeFlag |
| static bool | theRequestClassUpdateFlag |
| static bool | theRequestObjectUpdateFlag |
| static bool | theRequestWhenInitializedFlag |
| static bool | theRequestUpdateFlags |
| static bool | theDefaultWaitListRefreshFlag |
| static DtTime | theDefaultWaitListRefreshPeriod |
An instance of this class manages the list of "Test" objects that are simulated remotely, and reflected to us by the RTI.
This class is derived from DtReflectedObjectList, which does most of the work. The derived class mostly exists to provide type safety, and to let the base class know which FOM classes should be managed by this list.
| ReflectedTestList::ReflectedTestList | ( | DtExerciseConn * | exConn | ) |
Constructor.
|
virtual |
destructor
|
virtual |
Functions that allow a user to register callbacks that will be called when "Test" objects are added and removed from the list.
Registration/deregistration of object addition callbacks
|
virtual |
Registration/deregistration of object removal callbacks.
|
virtual |
Get the first/last object in the list.
|
virtual |
|
virtual |
The following public functions are not required by VR-Link, but they are strongly recommended.
The functions call down to base class versions, and cast to and from more generic types. Look up object by identifier.
|
virtual |
Look up object by name (global object designator).
|
protectedvirtual |
Override of virtual function that the base class uses to create the appropriate kind of DtReflectedObject.
Here, we create a ReflectedTest.
Implements DtReflectedObjectList.
|
virtual |
|
virtual |
