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
DtReflectedPointObjectList Class Reference

Instances of this class provide a protocol independent interface to a list of reflected Point Objects in a DIS environment. More...

+ Inheritance diagram for DtReflectedPointObjectList:
+ Collaboration diagram for DtReflectedPointObjectList:

Public Member Functions

 DtReflectedPointObjectList (DtExerciseConn *exConn, int numBucketsPrimeNumber=503)
 CTOR. More...
 
virtual ~DtReflectedPointObjectList ()
 Virtual DTOR. More...
 
virtual DtReflectedPointObjectlookup (const DtEntityIdentifier &id) const
 Lookup a Point Object from the Event ID. More...
 
virtual DtReflectedPointObjectfirst () const
 Get the first and last elements of the reflected Point Object's list. More...
 
virtual DtReflectedPointObjectlast () const
 
virtual void addPointObjectAdditionCallback (DtPointObjectCallbackFunction cb, void *usr)
 "Point Object Added" callback registration/deregistration. More...
 
virtual void removePointObjectAdditionCallback (DtPointObjectCallbackFunction cb, void *usr)
 
virtual void addPointObjectRemovalCallback (DtPointObjectCallbackFunction cb, void *usr)
 "Point Object Removed" callback registration/deregistration. More...
 
virtual void removePointObjectRemovalCallback (DtPointObjectCallbackFunction cb, void *usr)
 
virtual void print () const
 Print the SRs of all reflected Point Object. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the SRs 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 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 DtReflectedObjectnewReflectedObj (const DtStateMsg &msg)
 Overrides the base class implementation. Always returns NULL. More...
 
virtual DtReflectedPointObjectnewReflectedPointObject (const DtEntityIdentifier &id)
 Creates a new reflected Point Object. More...
 
virtual int acceptPdu (const DtStateMsg &msg) const
 Overrides the base class implementation. More...
 
virtual DtReflectedObjectprocessStateMessage (const DtStateMsg &msg)
 Overrides the base class implementation. Processes a Point Object Pdu. More...
 
virtual void removeAndDelete (DtReflectedObject *obj, char *msg=0)
 Print message 'msg' and execute the registered "ObjectRemoval" callbacks. More...
 
virtual void objectAdded (DtReflectedObject *obj)
 Called after a reflected point object is added to the list and before addition callbacks are processed. More...
 
const DtBaseHashKeyhashKeyFromStateMessage (const DtStateMsg *)
 Overrides the base class implementation. More...
 
 DtReflectedPointObjectList (const DtReflectedPointObjectList &)
 Copy constructor – Not Implemented. More...
 
DtReflectedPointObjectListoperator= (const DtReflectedPointObjectList &)
 Assignment operator – Not Implemented. 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 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 pointObjectCb (DtPointObjectStatePdu *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

DtEntityIdentifierHashKey myHashKey
 
- Protected Attributes inherited from DtReflectedObjectList
DtExerciseConnmyExConn
 
DtIntrusiveList myObjectAddedCallbacks
 
DtIntrusiveList myObjectRemovedCallbacks
 
DtIntrusiveList myWaitlistAddedCallbacks
 
DtIntrusiveList myWaitlistRemovedCallbacks
 
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 Point Objects in a DIS environment.

Constructor & Destructor Documentation

DtReflectedPointObjectList::DtReflectedPointObjectList ( DtExerciseConn exConn,
int  numBucketsPrimeNumber = 503 
)

CTOR.

virtual DtReflectedPointObjectList::~DtReflectedPointObjectList ( )
virtual

Virtual DTOR.

DtReflectedPointObjectList::DtReflectedPointObjectList ( const DtReflectedPointObjectList )
protected

Copy constructor – Not Implemented.

Member Function Documentation

virtual int DtReflectedPointObjectList::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 DtReflectedPointObjectList::addPointObjectAdditionCallback ( DtPointObjectCallbackFunction  cb,
void *  usr 
)
virtual

"Point Object Added" callback registration/deregistration.

virtual void DtReflectedPointObjectList::addPointObjectRemovalCallback ( DtPointObjectCallbackFunction  cb,
void *  usr 
)
virtual

"Point Object Removed" callback registration/deregistration.

virtual DtReflectedPointObject* DtReflectedPointObjectList::first ( ) const
virtual

Get the first and last elements of the reflected Point Object's list.

const DtBaseHashKey& DtReflectedPointObjectList::hashKeyFromStateMessage ( const DtStateMsg )
protectedvirtual

Overrides the base class implementation.

Generates a corresponding key from a Point Object Pdu. Returns an instance of 'DtEventIdHashKey'. 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 DtReflectedPointObject* DtReflectedPointObjectList::last ( ) const
virtual
virtual DtReflectedPointObject* DtReflectedPointObjectList::lookup ( const DtEntityIdentifier id) const
virtual

Lookup a Point Object from the Event ID.

virtual DtReflectedObject* DtReflectedPointObjectList::newReflectedObj ( const DtStateMsg msg)
protectedvirtual

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual DtReflectedPointObject* DtReflectedPointObjectList::newReflectedPointObject ( const DtEntityIdentifier id)
protectedvirtual

Creates a new reflected Point Object.

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

virtual void DtReflectedPointObjectList::objectAdded ( DtReflectedObject obj)
protectedvirtual

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

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedPointObjectList& DtReflectedPointObjectList::operator= ( const DtReflectedPointObjectList )
protected

Assignment operator – Not Implemented.

static void DtReflectedPointObjectList::pointObjectCb ( DtPointObjectStatePdu pdu,
void *  usr 
)
staticprotected

Callback for the exercise connection.

virtual void DtReflectedPointObjectList::print ( ) const
virtual

Print the SRs of all reflected Point Object.

Reimplemented from DtReflectedObjectList.

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

Print the SRs to a stream.

virtual DtReflectedObject* DtReflectedPointObjectList::processStateMessage ( const DtStateMsg msg)
protectedvirtual

Overrides the base class implementation. Processes a Point Object Pdu.

Reimplemented from DtReflectedObjectList.

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

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

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

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedPointObjectList::removePointObjectAdditionCallback ( DtPointObjectCallbackFunction  cb,
void *  usr 
)
virtual
virtual void DtReflectedPointObjectList::removePointObjectRemovalCallback ( DtPointObjectCallbackFunction  cb,
void *  usr 
)
virtual

Member Data Documentation

DtEntityIdentifierHashKey DtReflectedPointObjectList::myHashKey
protected

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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)