VR-Link API Documentation for HLA 1516
Public Member Functions | Protected Member Functions
ReflectedTestList Class Reference

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:

List of all members.

Public Member Functions

 ReflectedTestList (DtExerciseConn *exConn)
 Constructor.
virtual ~ReflectedTestList ()
 destructor
virtual ReflectedTestlookup (RTI::ObjectInstanceHandle id)
 The following public functions are not required by VR-Link, but they are strongly recommended.
virtual ReflectedTestlookup (const DtGlobalObjectDesignator &objName)
 Look up object by name (global object designator).
virtual ReflectedTestfirst () const
 Get the first/last object in the list.
virtual ReflectedTestlast () 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.
virtual void removeTestAdditionCallback (TestCallbackFunction cb, void *userData)
virtual void addTestRemovalCallback (TestCallbackFunction cb, void *userData)
 Registration/deregistration of object removal callbacks.
virtual void removeTestRemovalCallback (TestCallbackFunction cb, void *userData)

Protected Member Functions

virtual DtReflectedObjectnewReflectedObject (DtHlaObject *obj) const
 Override of virtual function that the base class uses to create the appropriate kind of DtReflectedObject.

Detailed Description

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.


Constructor & Destructor Documentation

Constructor.

destructor


Member Function Documentation

virtual void ReflectedTestList::addTestAdditionCallback ( TestCallbackFunction  cb,
void *  userData 
) [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 void ReflectedTestList::addTestRemovalCallback ( TestCallbackFunction  cb,
void *  userData 
) [virtual]

Registration/deregistration of object removal callbacks.

virtual ReflectedTest* ReflectedTestList::first ( ) const [virtual]

Get the first/last object in the list.

virtual ReflectedTest* ReflectedTestList::last ( ) const [virtual]
virtual ReflectedTest* ReflectedTestList::lookup ( RTI::ObjectInstanceHandle  id) [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 ReflectedTest* ReflectedTestList::lookup ( const DtGlobalObjectDesignator objName) [virtual]

Look up object by name (global object designator).

virtual DtReflectedObject* ReflectedTestList::newReflectedObject ( DtHlaObject obj) const [protected, virtual]

Override of virtual function that the base class uses to create the appropriate kind of DtReflectedObject.

Here, we create a ReflectedTest.

Implements DtReflectedObjectList.

virtual void ReflectedTestList::removeTestAdditionCallback ( TestCallbackFunction  cb,
void *  userData 
) [virtual]
virtual void ReflectedTestList::removeTestRemovalCallback ( TestCallbackFunction  cb,
void *  userData 
) [virtual]

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)