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

Instances of DtReflectedActiveSonarBeamList manage a list of remote ActiveSonarBeams in the exercise. More...

+ Inheritance diagram for DtReflectedActiveSonarBeamList:
+ Collaboration diagram for DtReflectedActiveSonarBeamList:

List of all members.

Public Member Functions

 DtReflectedActiveSonarBeamList (DtExerciseConn *exConn, const DtDDMRegionSet *regionSetToUse=0, const DtString &updateRateTag=DtString(""))
 Constructor obtains the set of object classes to subscribe to from the exConn's FOM Mapper.
 DtReflectedActiveSonarBeamList (DtExerciseConn *exConn, const DtList *handleList, const DtDDMRegionSet *regionSetToUse=0, const DtString &updateRateTag=DtString(""))
 Constructor that only subscribes to the RTI::ObjectClassHandles in handleList.
virtual ~DtReflectedActiveSonarBeamList ()
 Destructor.
virtual
DtReflectedActiveSonarBeam
lookup (RTI::ObjectHandle id)
 Returns the reflected ActiveSonarBeam specified by object handle.
virtual
DtReflectedActiveSonarBeam
lookup (const DtGlobalObjectDesignator &objName)
 Returns the reflected ActiveSonarBeam specified by object name.
virtual
DtReflectedActiveSonarBeam
first () const
 Returns the first reflected ActiveSonarBeam in the list.
virtual
DtReflectedActiveSonarBeam
last () const
 Returns the last reflected ActiveSonarBeam in the list.
virtual void addActiveSonarBeamAdditionCallback (DtActiveSonarBeamCallbackFunction cb, void *userData)
 Add a user-defined callback to be called when a new ActiveSonarBeam is added to the list.
virtual void removeActiveSonarBeamAdditionCallback (DtActiveSonarBeamCallbackFunction cb, void *userData)
 Remove a user-defined callback that is called when a new ActiveSonarBeam is added to the list.
virtual void addActiveSonarBeamRemovalCallback (DtActiveSonarBeamCallbackFunction cb, void *userData)
 Add a user-defined callback to be called when an ActiveSonarBeam is removed from the list.
virtual void removeActiveSonarBeamRemovalCallback (DtActiveSonarBeamCallbackFunction cb, void *userData)
 Remove a user-defined callback that is called when an ActiveSonarBeam is removed from the list.

Protected Member Functions

 DtReflectedActiveSonarBeamList (const DtReflectedActiveSonarBeamList &orig)
 Copy constructor not implemented.
DtReflectedActiveSonarBeamListoperator= (const DtReflectedActiveSonarBeamList &orig)
 Assignment operator not implemented.
virtual DtReflectedObjectnewReflectedObject (DtHlaObject *obj) const
 Override of virtual function.
virtual void objectAdded (DtReflectedObject *object)
 Called from processDiscoverObject() after a remote ActiveSonarBeam 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 DtReflectedActiveSonarBeamList manage a list of remote ActiveSonarBeams in the exercise.


Constructor & Destructor Documentation

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

Constructor obtains the set of object classes to subscribe to from the exConn's FOM Mapper.

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

Constructor that only subscribes to the RTI::ObjectClassHandles in handleList.

Destructor.

Copy constructor not implemented.


Member Function Documentation

Add a user-defined callback to be called when a new ActiveSonarBeam is added to the list.

Add a user-defined callback to be called when an ActiveSonarBeam is removed from the list.

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

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

Returns the first reflected ActiveSonarBeam in the list.

Returns NULL if list is empty.

Returns the last reflected ActiveSonarBeam in the list.

Returns NULL if list is empty.

virtual DtReflectedActiveSonarBeam* DtReflectedActiveSonarBeamList::lookup ( RTI::ObjectHandle  id) [virtual]

Returns the reflected ActiveSonarBeam specified by object handle.

Returns the reflected ActiveSonarBeam specified by object name.

Override of virtual function.

Here, we create a new DtReflectedActiveSonarBeam.

Implements DtReflectedObjectList.

virtual void DtReflectedActiveSonarBeamList::objectAdded ( DtReflectedObject object) [protected, virtual]

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

Default implementation prints a message. Subclasses can override this function to add functionality on addition.

Parameters:
objectwill be an instance of a class derived from DtReflectedObj.

Reimplemented from DtReflectedObjectList.

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

Assignment operator not implemented.

Remove a user-defined callback that is called when a new ActiveSonarBeam is added to the list.

Remove a user-defined callback that is called when an ActiveSonarBeam is removed from the list.


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)