VR-Link API Documentation for DIS
List of all members | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtReflectedIffList Class Reference

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

+ Inheritance diagram for DtReflectedIffList:
+ Collaboration diagram for DtReflectedIffList:

Public Member Functions

 DtReflectedIffList (DtExerciseConn *exConn)
 Constructor.
virtual ~DtReflectedIffList ()
 Destructor.
virtual DtReflectedIfflookup (const DtGlobalObjectDesignator &emittingEntity, DtU16 systemType, DtU16 systemName, DtU8 systemDesignator) const
 Lookup an emitter from its object ID.
virtual DtReflectedIfffirst () const
 Get the first and last elements of the IFF list.
virtual DtReflectedIfflast () const
virtual void addIffAdditionCallback (DtIffCallbackFunction cb, void *userData)
 Emitter added callback registration/deregistration.
virtual void removeIffAdditionCallback (DtIffCallbackFunction cb, void *userData)
virtual void addEmitterAdditionCallback (DtIffCallbackFunction cb, void *userData)
 DEPRECATED, USE addIffAdditionCallback.
virtual void removeEmitterAdditionCallback (DtIffCallbackFunction cb, void *userData)
 DEPRECATED, USE removeIffAdditionCallbac.
virtual void addIffRemovalCallback (DtIffCallbackFunction cb, void *userData)
 Emitter removed callback registration/deregistration.
virtual void removeIffRemovalCallback (DtIffCallbackFunction cb, void *userData)
virtual void addEmitterRemovalCallback (DtIffCallbackFunction cb, void *userData)
 DEPRECATED, use addIffRemovalCallback.
virtual void removeEmitterRemovalCallback (DtIffCallbackFunction cb, void *userData)
 DEPRECATED, use removeIffRemovalCallback.
virtual void print ()
 Print the SRs of all objects.
- 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 DtReflectedObjectfirstObj () const
 Get the first/last object in the list.
virtual DtReflectedObjectlastObj () const
virtual int count () const
 Get number of objects.
virtual DtReflectedObjectlookupObj (const DtBaseHashKey &key) const
 Search for an object.
virtual DtExerciseConnexerciseConn () 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 print () const
 Print the SRs of all objects.
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

DtReflectedIffListoperator= (const DtReflectedIffList &orig)
 Assignment operator – not implemented.
 DtReflectedIffList (const DtReflectedIffList &orig)
 Copy constructor – not implemented.
virtual DtReflectedIffnewReflectedIff (const DtGlobalObjectDesignator &emittingEntity, DtU16 systemType, DtU16 systemName, DtU8 systemDesignator)
 Create a new object from a global designator.
virtual DtReflectedObjectnewReflectedObj (const DtStateMsg &msg)
 Overrides base class's implementation. Always returns NULL.
virtual DtReflectedObjectprocessStateMessage (const DtStateMsg &msg)
 Process an incoming state message.
virtual void objectAdded (DtReflectedObject *obj)
 Called after an entity is added and before addition callbacks are processed.
virtual const DtBaseHashKeyhashKeyFromStateMessage (const DtStateMsg *msg)
 Get a hash key from a state message.
- Protected Member Functions inherited from DtReflectedObjectList
 DtReflectedObjectList (const DtReflectedObjectList &orig)
 copy constructor – not implemented
DtReflectedObjectListoperator= (const DtReflectedObjectList &orig)
 assignment operator – not implemented
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 DtBaseHashKeyhashKeyFromAttributeRecordSet (const DtAttributeRecordSet &recordSet)
 Get a hash key from an attribute record set.
virtual int acceptPdu (const DtStateMsg &) const
 Determines if a PDU should be processed or not.
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 emIffCb (DtIffAtcNavaidsPdu *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

DtIFFSystemHashKeymyHashKey
- Protected Attributes inherited from DtReflectedObjectList
DtExerciseConnmyExConn
DtIntrusiveList myObjectAddedCallbacks
DtIntrusiveList myObjectRemovedCallbacks
DtIntrusiveList myObjectList
DtIntrusiveList myWaitList
DtHashlist myObjectHashlist
DtHashlist myWaitHashlist
DtTime myTimeoutInterval
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 emitters in a DIS environment.

Constructor & Destructor Documentation

DtReflectedIffList::DtReflectedIffList ( DtExerciseConn exConn)

Constructor.

virtual DtReflectedIffList::~DtReflectedIffList ( )
virtual

Destructor.

DtReflectedIffList::DtReflectedIffList ( const DtReflectedIffList orig)
protected

Copy constructor – not implemented.

Member Function Documentation

virtual void DtReflectedIffList::addEmitterAdditionCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

DEPRECATED, USE addIffAdditionCallback.

virtual void DtReflectedIffList::addEmitterRemovalCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

DEPRECATED, use addIffRemovalCallback.

virtual void DtReflectedIffList::addIffAdditionCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

Emitter added callback registration/deregistration.

virtual void DtReflectedIffList::addIffRemovalCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

Emitter removed callback registration/deregistration.

static void DtReflectedIffList::emIffCb ( DtIffAtcNavaidsPdu pdu,
void *  usr 
)
staticprotected

Callback for the exercise connection.

virtual DtReflectedIff* DtReflectedIffList::first ( ) const
virtual

Get the first and last elements of the IFF list.

virtual const DtBaseHashKey& DtReflectedIffList::hashKeyFromStateMessage ( const DtStateMsg msg)
protectedvirtual

Get a hash key from a state message.

Implements DtReflectedObjectList.

virtual DtReflectedIff* DtReflectedIffList::last ( ) const
virtual
virtual DtReflectedIff* DtReflectedIffList::lookup ( const DtGlobalObjectDesignator emittingEntity,
DtU16  systemType,
DtU16  systemName,
DtU8  systemDesignator 
) const
virtual

Lookup an emitter from its object ID.

virtual DtReflectedIff* DtReflectedIffList::newReflectedIff ( const DtGlobalObjectDesignator emittingEntity,
DtU16  systemType,
DtU16  systemName,
DtU8  systemDesignator 
)
protectedvirtual

Create a new object from a global designator.

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

Overrides base class's implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual void DtReflectedIffList::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.

DtReflectedIffList& DtReflectedIffList::operator= ( const DtReflectedIffList orig)
protected

Assignment operator – not implemented.

virtual void DtReflectedIffList::print ( )
virtual

Print the SRs of all objects.

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

Process an incoming state message.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedIffList::removeEmitterAdditionCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

DEPRECATED, USE removeIffAdditionCallbac.

virtual void DtReflectedIffList::removeEmitterRemovalCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

DEPRECATED, use removeIffRemovalCallback.

virtual void DtReflectedIffList::removeIffAdditionCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual
virtual void DtReflectedIffList::removeIffRemovalCallback ( DtIffCallbackFunction  cb,
void *  userData 
)
virtual

Member Data Documentation

DtIFFSystemHashKey* DtReflectedIffList::myHashKey
protected

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

Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)