VR-Link API Documentation for HLA 1.3
Public Member Functions | Protected Member Functions
DtReflectedEnvironmentProcessList Class Reference

Instances of DtReflectedEnvironmentProcessList manage the list of remote environmental processes in the exercise. More...

+ Inheritance diagram for DtReflectedEnvironmentProcessList:
+ Collaboration diagram for DtReflectedEnvironmentProcessList:

List of all members.

Public Member Functions

 DtReflectedEnvironmentProcessList (DtExerciseConn *exConn, const DtDDMRegionSet *regionSetToUse=0, const DtString &updateRateTag=DtString(""))
 Constructor - obtains the set of object classes to subscribe to from the exConn's fomMapper.
 DtReflectedEnvironmentProcessList (DtExerciseConn *exConn, const DtList *handleList, const DtDDMRegionSet *regionSetToUse=0, const DtString &updateRateTag=DtString(""))
 Constructor - only subscribe to the RTI::ObjectClassHandles in handleList.
virtual ~DtReflectedEnvironmentProcessList ()
 destructor
virtual
DtReflectedEnvironmentProcess
lookup (RTI::ObjectHandle id)
 Look up environmental process by identifier.
virtual
DtReflectedEnvironmentProcess
lookup (const DtGlobalObjectDesignator &objName)
 Look up environmental process by name.
virtual
DtReflectedEnvironmentProcess
first () const
 Get the first/last environmental process in the list.
virtual
DtReflectedEnvironmentProcess
last () const
virtual void addEnvironmentProcessAdditionCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
 Environmental process added callback registration/deregistration.
virtual void removeEnvironmentProcessAdditionCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
virtual void addEnvironmentProcessRemovalCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
 Environmental process removed callback registration/deregistration.
virtual void removeEnvironmentProcessRemovalCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)

Protected Member Functions

 DtReflectedEnvironmentProcessList (const DtReflectedEnvironmentProcessList &orig)
 copy constructor -- not implemented
DtReflectedEnvironmentProcessListoperator= (const DtReflectedEnvironmentProcessList &orig)
 assignment operator -- not implemented
virtual DtReflectedObjectnewReflectedObject (DtHlaObject *obj) const
 Override of virtual function.
virtual void objectAdded (DtReflectedObject *obj)
 Called from processDiscoverObject() after a remote environment process has been added to the list.
virtual const DtListdfltHandleList ()
 Returns a DtList of RTI::ObjectClassHandles that represent the list of object classes to which this list should subscribe.

Detailed Description

Instances of DtReflectedEnvironmentProcessList manage the list of remote environmental processes in the exercise.

Examples: Environmental Process Example


Constructor & Destructor Documentation

DtReflectedEnvironmentProcessList::DtReflectedEnvironmentProcessList ( DtExerciseConn exConn,
const DtDDMRegionSet regionSetToUse = 0,
const DtString updateRateTag = DtString("") 
)

Constructor - obtains the set of object classes to subscribe to from the exConn's fomMapper.

DtReflectedEnvironmentProcessList::DtReflectedEnvironmentProcessList ( DtExerciseConn exConn,
const DtList handleList,
const DtDDMRegionSet regionSetToUse = 0,
const DtString updateRateTag = DtString("") 
)

Constructor - only subscribe to the RTI::ObjectClassHandles in handleList.

destructor

copy constructor -- not implemented


Member Function Documentation

Environmental process added callback registration/deregistration.

Environmental process removed callback registration/deregistration.

virtual const DtList* DtReflectedEnvironmentProcessList::dfltHandleList ( ) [protected, virtual]

Returns a DtList of RTI::ObjectClassHandles that represent the list of object classes to which this list should subscribe.

Get the first/last environmental process in the list.

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcessList::lookup ( RTI::ObjectHandle  id) [virtual]

Look up environmental process by identifier.

Look up environmental process by name.

Override of virtual function.

Here, we create a DtReflectedEnvironmentProcess.

Implements DtReflectedObjectList.

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

Called from processDiscoverObject() after a remote environment process has been added to the list.

Default implementation prints a message. Subclasses can override this function to add functionality on addition. obj will be an instance of a class derived from DtReflectedObj.

Reimplemented from DtReflectedObjectList.

DtReflectedEnvironmentProcessList& DtReflectedEnvironmentProcessList::operator= ( const DtReflectedEnvironmentProcessList orig) [protected]

assignment operator -- not implemented


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)