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:

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.
DtFederateStateRepository &	operator= (const DtFederateStateRepository &orig)
	Assignment operator.
virtual DtStateRepository *	clone (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 DtString &	federateType () const
	Get/Set the Federate Type.
void	setFederateType (const DtString &val)
	Get/Set the Federate Type.
const DtString &	federateName () 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 DtString &	federateHost () const
	Get/Set the Federate Host.
void	setFederateHost (const DtString &val)
	Get/Set the Federate Host.
const DtString &	rtiVersion () const
	Get/Set the RTI Version.
void	setRtiVersion (const DtString &val)
	Get/Set the RTI Version.
const DtString &	fedId () 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 DtString &	federateState () const
	Get/Set the federate state.
void	setFederateState (const DtString &val)
	Get/Set the federate state.
const DtString &	timeManagerState () const
	Get/Set the time manager state.
void	setTimeManagerState (const DtString &val)
	Get/Set the time manager state.
const DtString &	federateTime () const
	Get/Set the federate time.
void	setFederateTime (const DtString &val)
	Get/Set the federate time.
const DtString &	lookahead () const
	Get/Set the lookahead.
void	setLookahead (const DtString &val)
	Get/Set the lookahead.
const DtString &	lbts () const
	Get/Set the LBTS (lower-bound timestamp).
void	setLbts (const DtString &val)
	Get/Set the LBTS (lower-bound timestamp).
const DtString &	minNextEventTime () 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.
Public Member Functions inherited from DtStateRepository
virtual	~DtStateRepository ()
	destructor
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator
virtual void	setGlobalId (const DtGlobalObjectDesignator &id)
	Get/Set global identifier, or name.
virtual const DtGlobalObjectDesignator &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle.
virtual const DtObjectId &	localId () const

Static Public Member Functions
static DtFederateStateRepository *	create ()
	Create a DtFederateStateRepository.

Protected Attributes
RTI::FederateHandle	myFederateHandle
DtString	myFederateType
DtString	myFederateHost
DtString	myFederateName
bool	myConveyProducingFederate
std::vector< DtString >	myFomModules
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
Protected Attributes inherited from DtStateRepository
DtGlobalObjectDesignator	myGlobalId
DtObjectId	myLocalId

Additional Inherited Members
Protected Member Functions inherited from DtStateRepository
	DtStateRepository ()
	Constructors are protected since this is an abstract base class.
	DtStateRepository (const DtStateRepository &orig)
	copy constructor

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

enum DtFederateStateRepository::DtFederateState

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

enum DtFederateStateRepository::DtTimeState

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

DtFederateStateRepository::DtFederateStateRepository

(

)

Constructor.

virtual DtFederateStateRepository::~DtFederateStateRepository ( )

virtual

Destructor.

DtFederateStateRepository::DtFederateStateRepository

(

const DtFederateStateRepository &

orig

)

Copy constructor.

Member Function Documentation

bool DtFederateStateRepository::asynchronousDelivery

(

)

const

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.

bool DtFederateStateRepository::conveyProducingFederate

(

)

const

Get/Set whether conveyProducingFederate is enabled.

static DtFederateStateRepository* DtFederateStateRepository::create ( )

static

Create a DtFederateStateRepository.

const RTI::FederateHandle& DtFederateStateRepository::federateHandle

(

)

const

Get/Set the Federate Handle.

const DtString& DtFederateStateRepository::federateHost

(

)

const

Get/Set the Federate Host.

const DtString& DtFederateStateRepository::federateName

(

)

const

Get/Set the Federate Name.

const DtString& DtFederateStateRepository::federateState

(

)

const

Get/Set the federate state.

const DtString& DtFederateStateRepository::federateTime

(

)

const

Get/Set the federate time.

const DtString& DtFederateStateRepository::federateType

(

)

const

Get/Set the Federate Type.

const DtString& DtFederateStateRepository::fedId

(

)

const

Get/Set the FED ID.

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

const std::vector<DtString>& DtFederateStateRepository::fomModuleDesignatorList

(

)

const

Get / Set the list of fom modules.

int DtFederateStateRepository::interactionsReceived

(

)

const

Get/Set the number of interactions received.

int DtFederateStateRepository::interactionsSent

(

)

const

Get/Set the number of interactions sent.

const DtString& DtFederateStateRepository::lbts

(

)

const

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

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

const DtString& DtFederateStateRepository::lookahead

(

)

const

Get/Set the lookahead.

const DtString& DtFederateStateRepository::minNextEventTime

(

)

const

Get/Set the minimum next event time.

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

int DtFederateStateRepository::objectsOwned

(

)

const

Get/Set the number of objects owned.

int DtFederateStateRepository::objectsReflected

(

)

const

Get/Set the number of objects reflected.

int DtFederateStateRepository::objectsUpdated

(

)

const

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.

int DtFederateStateRepository::reflectionsReceived

(

)

const

Get/Set the number of reflections received.

int DtFederateStateRepository::roLength

(

)

const

Get/Set the RO Length.

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

const DtString& DtFederateStateRepository::rtiVersion

(

)

const

Get/Set the RTI Version.

void DtFederateStateRepository::setAsynchronousDelivery

(

bool

val

)

Get/Set the asynchronous delivery flag.

void DtFederateStateRepository::setConveyProducingFederate

(

bool

val

)

Get/Set whether conveyProducingFederate is enabled.

void DtFederateStateRepository::setFederateHandle

(

const RTI::FederateHandle &

val

)

Get/Set the Federate Handle.

void DtFederateStateRepository::setFederateHost

(

const DtString &

val

)

Get/Set the Federate Host.

void DtFederateStateRepository::setFederateName

(

const DtString &

val

)

Get/Set the Federate Name.

void DtFederateStateRepository::setFederateState

(

const DtString &

val

)

Get/Set the federate state.

void DtFederateStateRepository::setFederateTime

(

const DtString &

val

)

Get/Set the federate time.

void DtFederateStateRepository::setFederateType

(

const DtString &

val

)

Get/Set the Federate Type.

void DtFederateStateRepository::setFedId

(

const DtString &

val

)

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.

void DtFederateStateRepository::setInteractionsReceived

(

int

val

)

Get/Set the number of interactions received.

void DtFederateStateRepository::setInteractionsSent

(

int

val

)

Get/Set the number of interactions sent.

void DtFederateStateRepository::setLbts

(

const DtString &

val

)

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

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

void DtFederateStateRepository::setLookahead

(

const DtString &

val

)

Get/Set the lookahead.

void DtFederateStateRepository::setMinNextEventTime

(

const DtString &

val

)

Get/Set the minimum next event time.

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

void DtFederateStateRepository::setObjectsOwned

(

int

val

)

Get/Set the number of objects owned.

void DtFederateStateRepository::setObjectsReflected

(

int

val

)

Get/Set the number of objects reflected.

void DtFederateStateRepository::setObjectsUpdated

(

int

val

)

Get/Set the number of objects updated.

void DtFederateStateRepository::setReflectionsReceived

(

int

val

)

Get/Set the number of reflections received.

void DtFederateStateRepository::setRoLength

(

int

val

)

Get/Set the RO Length.

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

void DtFederateStateRepository::setRtiVersion

(

const DtString &

val

)

Get/Set the RTI Version.

void DtFederateStateRepository::setTimeConstrained

(

bool

val

)

Get/Set the time constrained flag.

void DtFederateStateRepository::setTimeManagerState

(

const DtString &

val

)

Get/Set the time manager state.

void DtFederateStateRepository::setTimeRegulating

(

bool

val

)

Get/Set the time regulating flag.

void DtFederateStateRepository::setTsoLength

(

int

val

)

Get/Set the TSO Length.

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

void DtFederateStateRepository::setUpdatesSent

(

int

val

)

Get/Set the number of updates sent.

bool DtFederateStateRepository::timeConstrained

(

)

const

Get/Set the time constrained flag.

const DtString& DtFederateStateRepository::timeManagerState

(

)

const

Get/Set the time manager state.

bool DtFederateStateRepository::timeRegulating

(

)

const

Get/Set the time regulating flag.

int DtFederateStateRepository::tsoLength

(

)

const

Get/Set the TSO Length.

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

int DtFederateStateRepository::updatesSent

(

)

const

Get/Set the number of updates sent.

Member Data Documentation

bool DtFederateStateRepository::myAsynchronousDelivery

protected

bool DtFederateStateRepository::myConveyProducingFederate

protected

RTI::FederateHandle DtFederateStateRepository::myFederateHandle

protected

DtString DtFederateStateRepository::myFederateHost

protected

DtString DtFederateStateRepository::myFederateName

protected

DtString DtFederateStateRepository::myFederateState

protected

DtString DtFederateStateRepository::myFederateTime

protected

DtString DtFederateStateRepository::myFederateType

protected

DtString DtFederateStateRepository::myFedId

protected

std::vector<DtString> DtFederateStateRepository::myFomModules

protected

int DtFederateStateRepository::myInteractionsReceived

protected

int DtFederateStateRepository::myInteractionsSent

protected

DtString DtFederateStateRepository::myLbts

protected

DtString DtFederateStateRepository::myLookahead

protected

DtString DtFederateStateRepository::myMinNextEventTime

protected

int DtFederateStateRepository::myObjectsOwned

protected

int DtFederateStateRepository::myObjectsReflected

protected

int DtFederateStateRepository::myObjectsUpdated

protected

int DtFederateStateRepository::myReflectionsReceived

protected

int DtFederateStateRepository::myRoLength

protected

DtString DtFederateStateRepository::myRtiVersion

protected

bool DtFederateStateRepository::myTimeConstrained

protected

DtString DtFederateStateRepository::myTimeManagerState

protected

bool DtFederateStateRepository::myTimeRegulating

protected

int DtFederateStateRepository::myTsoLength

protected

int DtFederateStateRepository::myUpdatesSent

protected

---

The documentation for this class was generated from the following file:

• federateSR.h