VR-Link API Documentation for DIS
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtReflectedDesignatorList Class Reference

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

+ Inheritance diagram for DtReflectedDesignatorList:
+ Collaboration diagram for DtReflectedDesignatorList:

List of all members.

Public Member Functions

 DtReflectedDesignatorList (DtExerciseConn *exConn)
 Constructor.
virtual ~DtReflectedDesignatorList ()
 Destructor.
virtual DtReflectedDesignatorlookup (const DtGlobalObjectDesignator &designatingEntity, int designtrCode) const
 Lookup a designator from the object ID of its designating entity and its designator code.
virtual DtReflectedDesignatorfirst () const
 Get the first and last elements of the reflected designators' list.
virtual DtReflectedDesignatorlast () const
virtual void addDesignatorAdditionCallback (DtDesignatorCallbackFunction cb, void *userData)
 "Designator Added" callback registration/deregistration.
virtual void removeDesignatorAdditionCallback (DtDesignatorCallbackFunction cb, void *userData)
virtual void addDesignatorRemovalCallback (DtDesignatorCallbackFunction cb, void *userData)
 "Designator Removed" callback registration/deregistration.
virtual void removeDesignatorRemovalCallback (DtDesignatorCallbackFunction cb, void *userData)
virtual void print () const
 Print the SRs of all reflected designators.
virtual void printDataToStream (std::ostream &stream) const
 Print the SRs to a stream.

Protected Member Functions

virtual DtReflectedObjectnewReflectedObj (const DtStateMsg &msg)
 Overrides the base class implementation. Always returns NULL.
virtual DtReflectedDesignatornewReflectedDesignator (const DtEntityIdentifier &designatingEntity, int designatorCode)
 Creates a new reflected designator.
virtual int acceptPdu (const DtStateMsg &msg) const
 Overrides the base class implementation.
virtual DtReflectedObjectprocessStateMessage (const DtStateMsg &msg)
 Overrides the base class implementation. Processes a Designator Pdu.
virtual void removeAndDelete (DtReflectedObject *obj, char *msg=0)
 Print message 'msg' and execute the registered "ObjectRemoval" callbacks.
virtual void objectAdded (DtReflectedObject *obj)
 Called after a reflected designator is added to the list and before addition callbacks are processed.
const DtBaseHashKeyhashKeyFromStateMessage (const DtStateMsg *)
 Overrides the base class implementation.
 DtReflectedDesignatorList (const DtReflectedDesignatorList &)
 Copy constructor -- Not Implemented.
DtReflectedDesignatorListoperator= (const DtReflectedDesignatorList &)
 Assignment operator -- Not Implemented.

Static Protected Member Functions

static void designatorCb (DtDesignatorPdu *pdu, void *usr)
 Callback for the exercise connection.

Protected Attributes

DtSystemHashKeymyHashKey

Detailed Description

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


Constructor & Destructor Documentation

Constructor.

Destructor.

Copy constructor -- Not Implemented.


Member Function Documentation

virtual int DtReflectedDesignatorList::acceptPdu ( const DtStateMsg msg) const [protected, virtual]

Overrides the base class implementation.

Determines if a PDU should be processed or not. Always returns 1.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedDesignatorList::addDesignatorAdditionCallback ( DtDesignatorCallbackFunction  cb,
void *  userData 
) [virtual]

"Designator Added" callback registration/deregistration.

virtual void DtReflectedDesignatorList::addDesignatorRemovalCallback ( DtDesignatorCallbackFunction  cb,
void *  userData 
) [virtual]

"Designator Removed" callback registration/deregistration.

static void DtReflectedDesignatorList::designatorCb ( DtDesignatorPdu pdu,
void *  usr 
) [static, protected]

Callback for the exercise connection.

Get the first and last elements of the reflected designators' list.

Overrides the base class implementation.

Generates a corresponding key from a Designator Pdu. Returns an instance of 'DtSystemHashKey'. 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 DtReflectedDesignator* DtReflectedDesignatorList::lookup ( const DtGlobalObjectDesignator designatingEntity,
int  designtrCode 
) const [virtual]

Lookup a designator from the object ID of its designating entity and its designator code.

virtual DtReflectedDesignator* DtReflectedDesignatorList::newReflectedDesignator ( const DtEntityIdentifier designatingEntity,
int  designatorCode 
) [protected, virtual]

Creates a new reflected designator.

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

virtual DtReflectedObject* DtReflectedDesignatorList::newReflectedObj ( const DtStateMsg msg) [protected, virtual]

Overrides the base class implementation. Always returns NULL.

Implements DtReflectedObjectList.

virtual void DtReflectedDesignatorList::objectAdded ( DtReflectedObject obj) [protected, virtual]

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

Right now, it only calls DtInfo.

Reimplemented from DtReflectedObjectList.

DtReflectedDesignatorList& DtReflectedDesignatorList::operator= ( const DtReflectedDesignatorList ) [protected]

Assignment operator -- Not Implemented.

virtual void DtReflectedDesignatorList::print ( ) const [virtual]

Print the SRs of all reflected designators.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedDesignatorList::printDataToStream ( std::ostream &  stream) const [virtual]

Print the SRs to a stream.

virtual DtReflectedObject* DtReflectedDesignatorList::processStateMessage ( const DtStateMsg msg) [protected, virtual]

Overrides the base class implementation. Processes a Designator Pdu.

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedDesignatorList::removeAndDelete ( DtReflectedObject obj,
char *  msg = 0 
) [protected, virtual]

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

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

Reimplemented from DtReflectedObjectList.


Member Data Documentation


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)