VR-Link API Documentation for HLA Evolved
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
DtFederateStateRepository Class Reference

Instances of DtFederateStateRepsository are used to hold data from the RTI's Management Object Model Federate class. More...

+ Inheritance diagram for DtFederateStateRepository:
+ Collaboration diagram for DtFederateStateRepository:

List of all members.

Public Types

enum  DtFederateState { DtFedStateActiveFederate = 1, DtFedStateFederateSaveInProgress = 3, DtFedStateFederateRestoreInProgress = 5 }
 The state of a federate. More...
enum  DtTimeState { DtTimeStateTimeGranted = 0, DtTimeStateTimeAdvancing = 1 }
 The time state of a federate. More...

Public Member Functions

 DtFederateStateRepository ()
 Constructor.
virtual ~DtFederateStateRepository ()
 Destructor.
 DtFederateStateRepository (const DtFederateStateRepository &orig)
 Copy constructor.
DtFederateStateRepositoryoperator= (const DtFederateStateRepository &orig)
 Assignment operator.
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print data to the DtInfo stream.
virtual void printDataToStream (std::ostream &stream) const
 Print data to the specified stream.
const RTI::FederateHandle & federateHandle () const
 Get/Set the Federate Handle.
void setFederateHandle (const RTI::FederateHandle &val)
 Get/Set the Federate Handle.
const DtStringfederateType () const
 Get/Set the Federate Type.
void setFederateType (const DtString &val)
 Get/Set the Federate Type.
const DtStringfederateName () const
 Get/Set the Federate Name.
void setFederateName (const DtString &val)
 Get/Set the Federate Name.
bool conveyProducingFederate () const
 Get/Set whether conveyProducingFederate is enabled.
void setConveyProducingFederate (bool val)
 Get/Set whether conveyProducingFederate is enabled.
const std::vector< DtString > & fomModuleDesignatorList () const
 Get / Set the list of fom modules.
void setFomModuleDesignatorList (const std::vector< DtString > &modules)
 Get / Set the list of fom modules.
const DtStringfederateHost () const
 Get/Set the Federate Host.
void setFederateHost (const DtString &val)
 Get/Set the Federate Host.
const DtStringrtiVersion () const
 Get/Set the RTI Version.
void setRtiVersion (const DtString &val)
 Get/Set the RTI Version.
const DtStringfedId () const
 Get/Set the FED ID.
void setFedId (const DtString &val)
 Get/Set the FED ID.
bool timeConstrained () const
 Get/Set the time constrained flag.
void setTimeConstrained (bool val)
 Get/Set the time constrained flag.
bool timeRegulating () const
 Get/Set the time regulating flag.
void setTimeRegulating (bool val)
 Get/Set the time regulating flag.
bool asynchronousDelivery () const
 Get/Set the asynchronous delivery flag.
void setAsynchronousDelivery (bool val)
 Get/Set the asynchronous delivery flag.
const DtStringfederateState () const
 Get/Set the federate state.
void setFederateState (const DtString &val)
 Get/Set the federate state.
const DtStringtimeManagerState () const
 Get/Set the time manager state.
void setTimeManagerState (const DtString &val)
 Get/Set the time manager state.
const DtStringfederateTime () const
 Get/Set the federate time.
void setFederateTime (const DtString &val)
 Get/Set the federate time.
const DtStringlookahead () const
 Get/Set the lookahead.
void setLookahead (const DtString &val)
 Get/Set the lookahead.
const DtStringlbts () const
 Get/Set the LBTS (lower-bound timestamp).
void setLbts (const DtString &val)
 Get/Set the LBTS (lower-bound timestamp).
const DtStringminNextEventTime () const
 Get/Set the minimum next event time.
void setMinNextEventTime (const DtString &val)
 Get/Set the minimum next event time.
int roLength () const
 Get/Set the RO Length.
void setRoLength (int val)
 Get/Set the RO Length.
int tsoLength () const
 Get/Set the TSO Length.
void setTsoLength (int val)
 Get/Set the TSO Length.
int reflectionsReceived () const
 Get/Set the number of reflections received.
void setReflectionsReceived (int val)
 Get/Set the number of reflections received.
int updatesSent () const
 Get/Set the number of updates sent.
void setUpdatesSent (int val)
 Get/Set the number of updates sent.
int interactionsReceived () const
 Get/Set the number of interactions received.
void setInteractionsReceived (int val)
 Get/Set the number of interactions received.
int interactionsSent () const
 Get/Set the number of interactions sent.
void setInteractionsSent (int val)
 Get/Set the number of interactions sent.
int objectsOwned () const
 Get/Set the number of objects owned.
void setObjectsOwned (int val)
 Get/Set the number of objects owned.
int objectsUpdated () const
 Get/Set the number of objects updated.
void setObjectsUpdated (int val)
 Get/Set the number of objects updated.
int objectsReflected () const
 Get/Set the number of objects reflected.
void setObjectsReflected (int val)
 Get/Set the number of objects reflected.

Static Public Member Functions

static DtFederateStateRepositorycreate ()
 Create a DtFederateStateRepository.

Protected Attributes

RTI::FederateHandle myFederateHandle
DtString myFederateType
DtString myFederateHost
DtString myFederateName
bool myConveyProducingFederate
std::vector< DtStringmyFomModules
DtString myRtiVersion
DtString myFedId
bool myTimeConstrained
bool myTimeRegulating
bool myAsynchronousDelivery
DtString myFederateState
DtString myTimeManagerState
DtString myFederateTime
DtString myLookahead
DtString myLbts
DtString myMinNextEventTime
int myRoLength
int myTsoLength
int myReflectionsReceived
int myUpdatesSent
int myInteractionsReceived
int myInteractionsSent
int myObjectsOwned
int myObjectsUpdated
int myObjectsReflected

Detailed Description

Instances of DtFederateStateRepsository are used to hold data from the RTI's Management Object Model Federate class.

It represents a federate in the federation execution. This is used with the DtReflectedFederateList, and needs the MOM capability of the RTI enabled.


Member Enumeration Documentation

The state of a federate.

This enumeration is only applicable to HLA 1516, as the state is sent as a string in HLA 1.3.

Enumerator:
DtFedStateActiveFederate 
DtFedStateFederateSaveInProgress 
DtFedStateFederateRestoreInProgress 

The time state of a federate.

This enumeration is only applicable to HLA 1516, as the state is sent as a string in HLA 1.3.

Enumerator:
DtTimeStateTimeGranted 
DtTimeStateTimeAdvancing 

Constructor & Destructor Documentation

Constructor.

Destructor.

Copy constructor.


Member Function Documentation

Get/Set the asynchronous delivery flag.

virtual DtStateRepository* DtFederateStateRepository::clone ( bool  copy) const [virtual]

Return a copy/empty object of the same type as this.

Implements DtStateRepository.

Get/Set whether conveyProducingFederate is enabled.

const RTI::FederateHandle& DtFederateStateRepository::federateHandle ( ) const

Get/Set the Federate Handle.

Get/Set the Federate Host.

Get/Set the Federate Name.

Get/Set the federate state.

Get/Set the federate time.

Get/Set the Federate Type.

Get/Set the FED ID.

In HLA 1516, this attribute is referred to as the FDD ID.

Get / Set the list of fom modules.

Get/Set the number of interactions received.

Get/Set the number of interactions sent.

Get/Set the LBTS (lower-bound timestamp).

In HLA 1516, this synonymous with the GALT (greatest allowed logical time).

Get/Set the lookahead.

Get/Set the minimum next event time.

In HLA 1516, this synonymous with the LITS (least incoming timestamp).

Get/Set the number of objects owned.

Get/Set the number of objects reflected.

Get/Set the number of objects updated.

DtFederateStateRepository& DtFederateStateRepository::operator= ( const DtFederateStateRepository orig)

Assignment operator.

virtual void DtFederateStateRepository::printData ( ) const [virtual]

Print data to the DtInfo stream.

Implements DtStateRepository.

virtual void DtFederateStateRepository::printDataToStream ( std::ostream &  stream) const [virtual]

Print data to the specified stream.

Reimplemented from DtStateRepository.

Get/Set the number of reflections received.

Get/Set the RO Length.

This is the number of events currently queued for receive-ordered delivery.

Get/Set the RTI Version.

Get/Set the asynchronous delivery flag.

Get/Set whether conveyProducingFederate is enabled.

void DtFederateStateRepository::setFederateHandle ( const RTI::FederateHandle &  val)

Get/Set the Federate Handle.

Get/Set the Federate Host.

Get/Set the Federate Name.

Get/Set the federate state.

Get/Set the federate time.

Get/Set the Federate Type.

Get/Set the FED ID.

In HLA 1516, this attribute is referred to as the FDD ID.

void DtFederateStateRepository::setFomModuleDesignatorList ( const std::vector< DtString > &  modules)

Get / Set the list of fom modules.

Get/Set the number of interactions received.

Get/Set the number of interactions sent.

Get/Set the LBTS (lower-bound timestamp).

In HLA 1516, this synonymous with the GALT (greatest allowed logical time).

Get/Set the lookahead.

Get/Set the minimum next event time.

In HLA 1516, this synonymous with the LITS (least incoming timestamp).

Get/Set the number of objects owned.

Get/Set the number of objects reflected.

Get/Set the number of objects updated.

Get/Set the number of reflections received.

Get/Set the RO Length.

This is the number of events currently queued for receive-ordered delivery.

Get/Set the RTI Version.

Get/Set the time constrained flag.

Get/Set the time manager state.

Get/Set the time regulating flag.

Get/Set the TSO Length.

This is the number of events currently queued for time-stamp-ordered delivery.

Get/Set the number of updates sent.

Get/Set the time constrained flag.

Get/Set the time manager state.

Get/Set the time regulating flag.

Get/Set the TSO Length.

This is the number of events currently queued for time-stamp-ordered delivery.

Get/Set the number of updates sent.


Member Data Documentation

RTI::FederateHandle DtFederateStateRepository::myFederateHandle [protected]

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)