VR-Link API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | Private Types
DtReflectedFederate Class Reference

This class contains information about a Federate instance in HLA. More...

+ Inheritance diagram for DtReflectedFederate:
+ Collaboration diagram for DtReflectedFederate:

List of all members.

Public Member Functions

 DtReflectedFederate (DtHlaObject *obj, DtExerciseConn *exConn)
 Constructor.
virtual ~DtReflectedFederate ()
 Destructor.
virtual DtFederateStateRepositoryfederateRep () const
 Returns the Federate's state repository.
virtual DtFederateStateRepositoryfsr () const
 Shorter version of lifeformRep.
virtual DtReflectedFederatenext () const
 Returns the next reflected Federate in the DtReflectedFederateList.
virtual DtReflectedFederateprev () const
 Returns the previous reflected Federate in the DtReflectedFederateList.
virtual DtReflectedFederatewrapNext () const
 Returns the next reflected Federate.
virtual DtReflectedFederatewrapPrev () const
 Returns the previous reflected Federate.
virtual void addPostUpdateCallback (DtFederateCallbackFunction cb, void *userData)
 Add a callback that is called when the DtReflectedFederate is updated.
virtual void removePostUpdateCallback (DtFederateCallbackFunction cb, void *userData)
 Remove the callback that is called when the DtReflectedFederate is updated.

Static Public Member Functions

static DtStateRepCreator setStateRepCreator (DtStateRepCreator creator)
 Set the function to be called for creating state repositories.

Protected Member Functions

 DtReflectedFederate (const DtReflectedFederate &orig)
 Copy Constructor not implemented.
DtReflectedFederateoperator= (const DtReflectedFederate &orig)
 Assignment operator not implemented.

Static Protected Attributes

static DtStateRepCreator theStateRepCreator
 The function called to create state repositories.

Private Types

typedef
DtFederateStateRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create a DtFederateStateRepository.

Detailed Description

This class contains information about a Federate instance in HLA.

The data is populated from MOM data transmitted by the RTI as part of the HLA Standard.


Member Typedef Documentation

Function prototype for functions that create a DtFederateStateRepository.


Constructor & Destructor Documentation

Constructor.

Destructor.

Copy Constructor not implemented.


Member Function Documentation

virtual void DtReflectedFederate::addPostUpdateCallback ( DtFederateCallbackFunction  cb,
void *  userData 
) [virtual]

Add a callback that is called when the DtReflectedFederate is updated.

Returns the Federate's state repository.

References DtReflectedObject::myStateRep.

DtFederateStateRepository * DtReflectedFederate::fsr ( ) const [inline, virtual]

Shorter version of lifeformRep.

References DtReflectedObject::myStateRep.

virtual DtReflectedFederate* DtReflectedFederate::next ( ) const [virtual]

Returns the next reflected Federate in the DtReflectedFederateList.

Reimplemented from DtListedObj.

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

Assignment operator not implemented.

virtual DtReflectedFederate* DtReflectedFederate::prev ( ) const [virtual]

Returns the previous reflected Federate in the DtReflectedFederateList.

Reimplemented from DtListedObj.

virtual void DtReflectedFederate::removePostUpdateCallback ( DtFederateCallbackFunction  cb,
void *  userData 
) [virtual]

Remove the callback that is called when the DtReflectedFederate is updated.

Set the function to be called for creating state repositories.

virtual DtReflectedFederate* DtReflectedFederate::wrapNext ( ) const [virtual]

Returns the next reflected Federate.

Will cycle back to the first remote Federate in the DtReflectedFederateList.

Reimplemented from DtListedObj.

virtual DtReflectedFederate* DtReflectedFederate::wrapPrev ( ) const [virtual]

Returns the previous reflected Federate.

Will cycle back to the first remote Federate in the DtReflectedFederateList.

Reimplemented from DtListedObj.


Member Data Documentation

The function called to create state repositories.


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)