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

Instances of DtReflectedFederateList manage a list of DtReflectedFederate objects. More...

+ Inheritance diagram for DtReflectedFederateList:
+ Collaboration diagram for DtReflectedFederateList:

List of all members.

Public Member Functions

 DtReflectedFederateList (DtExerciseConn *exConn, const DtString &updateRateTag=DtString(""))
 Constructor.
virtual ~DtReflectedFederateList ()
 Destructor.
virtual DtReflectedFederate * lookup (RTI::ObjectHandle id)
 Look up by identifier.
virtual DtReflectedFederate * lookup (const DtGlobalObjectDesignator &objName)
 Look up by name.
virtual DtReflectedFederate * first () const
 Get the first reflected object in the list.
virtual DtReflectedFederate * last () const
 Get the last reflected object in the list.
virtual void addFederateAdditionCallback (DtFederateCallbackFunction cb, void *userData)
 Federate added callback registration.
virtual void removeFederateAdditionCallback (DtFederateCallbackFunction cb, void *userData)
 Federate added callback deregistration.
virtual void addFederateRemovalCallback (DtFederateCallbackFunction cb, void *userData)
 Federate removed callback registration.
virtual void removeFederateRemovalCallback (DtFederateCallbackFunction cb, void *userData)
 Federate removed callback deregistration.

Protected Member Functions

 DtReflectedFederateList (const DtReflectedFederateList &orig)
 Copy constructor not implemented - cannot be copied.
DtReflectedFederateList & operator= (const DtReflectedFederateList &orig)
 Assignment operator not implemented - cannot be copied.
virtual DtReflectedObject * newReflectedObject (DtHlaObject *obj) const
 Override of virtual function. Here, we create a DtReflectedFederate.
virtual void objectAdded (DtReflectedObject *obj)
 Called from processDiscoverObject() after a remote Federate has been added to the list.

Detailed Description

Instances of DtReflectedFederateList manage a list of DtReflectedFederate objects.


Constructor & Destructor Documentation

DtReflectedFederateList::DtReflectedFederateList ( DtExerciseConn *  exConn,
const DtString &  updateRateTag = DtString("") 
)

Constructor.

Destructor.

Copy constructor not implemented - cannot be copied.


Member Function Documentation

virtual void DtReflectedFederateList::addFederateAdditionCallback ( DtFederateCallbackFunction  cb,
void *  userData 
) [virtual]

Federate added callback registration.

virtual void DtReflectedFederateList::addFederateRemovalCallback ( DtFederateCallbackFunction  cb,
void *  userData 
) [virtual]

Federate removed callback registration.

Get the first reflected object in the list.

virtual DtReflectedFederate* DtReflectedFederateList::last ( ) const [virtual]

Get the last reflected object in the list.

virtual DtReflectedFederate* DtReflectedFederateList::lookup ( RTI::ObjectHandle  id) [virtual]

Look up by identifier.

Look up by name.

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

Override of virtual function. Here, we create a DtReflectedFederate.

Implements DtReflectedObjectList.

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

Called from processDiscoverObject() after a remote Federate 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.

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

Assignment operator not implemented - cannot be copied.

virtual void DtReflectedFederateList::removeFederateAdditionCallback ( DtFederateCallbackFunction  cb,
void *  userData 
) [virtual]

Federate added callback deregistration.

virtual void DtReflectedFederateList::removeFederateRemovalCallback ( DtFederateCallbackFunction  cb,
void *  userData 
) [virtual]

Federate removed callback deregistration.


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)