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 Types inherited from DtStateRepository
typedef std::map< DtString, DtStateRepositoryExtension * >	DtStateRepositoryExtensionMap

Public Member Functions
	DtFederateStateRepository ()
	Constructor. More...
virtual	~DtFederateStateRepository ()
	Destructor. More...
	DtFederateStateRepository (const DtFederateStateRepository &orig)
	Copy constructor. More...
DtFederateStateRepository &	operator= (const DtFederateStateRepository &orig)
	Assignment operator. More...
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this. More...
virtual void	printData () const
	Print data to the DtInfo stream. More...
virtual void	printDataToStream (std::ostream &stream) const
	Print data to the specified stream. More...
DtExerciseConn *	exConn () const
	Used for correct decoding of handles. More...
void	setExConn (DtExerciseConn *val)
const RTI::FederateHandle &	federateHandle () const
	Get/Set the Federate Handle. More...
void	setFederateHandle (const RTI::FederateHandle &val)
	Get/Set the Federate Handle. More...
const DtString &	federateType () const
	Get/Set the Federate Type. More...
void	setFederateType (const DtString &val)
	Get/Set the Federate Type. More...
const DtString &	federateHost () const
	Get/Set the Federate Host. More...
void	setFederateHost (const DtString &val)
	Get/Set the Federate Host. More...
const DtString &	rtiVersion () const
	Get/Set the RTI Version. More...
void	setRtiVersion (const DtString &val)
	Get/Set the RTI Version. More...
const DtString &	fedId () const
	Get/Set the FED ID. More...
void	setFedId (const DtString &val)
	Get/Set the FED ID. More...
bool	timeConstrained () const
	Get/Set the time constrained flag. More...
void	setTimeConstrained (bool val)
	Get/Set the time constrained flag. More...
bool	timeRegulating () const
	Get/Set the time regulating flag. More...
void	setTimeRegulating (bool val)
	Get/Set the time regulating flag. More...
bool	asynchronousDelivery () const
	Get/Set the asynchronous delivery flag. More...
void	setAsynchronousDelivery (bool val)
	Get/Set the asynchronous delivery flag. More...
const DtString &	federateState () const
	Get/Set the federate state. More...
void	setFederateState (const DtString &val)
	Get/Set the federate state. More...
const DtString &	timeManagerState () const
	Get/Set the time manager state. More...
void	setTimeManagerState (const DtString &val)
	Get/Set the time manager state. More...
const DtString &	federateTime () const
	Get/Set the federate time. More...
void	setFederateTime (const DtString &val)
	Get/Set the federate time. More...
const DtString &	lookahead () const
	Get/Set the lookahead. More...
void	setLookahead (const DtString &val)
	Get/Set the lookahead. More...
const DtString &	lbts () const
	Get/Set the LBTS (lower-bound timestamp). More...
void	setLbts (const DtString &val)
	Get/Set the LBTS (lower-bound timestamp). More...
const DtString &	minNextEventTime () const
	Get/Set the minimum next event time. More...
void	setMinNextEventTime (const DtString &val)
	Get/Set the minimum next event time. More...
int	roLength () const
	Get/Set the RO Length. More...
void	setRoLength (int val)
	Get/Set the RO Length. More...
int	tsoLength () const
	Get/Set the TSO Length. More...
void	setTsoLength (int val)
	Get/Set the TSO Length. More...
int	reflectionsReceived () const
	Get/Set the number of reflections received. More...
void	setReflectionsReceived (int val)
	Get/Set the number of reflections received. More...
int	updatesSent () const
	Get/Set the number of updates sent. More...
void	setUpdatesSent (int val)
	Get/Set the number of updates sent. More...
int	interactionsReceived () const
	Get/Set the number of interactions received. More...
void	setInteractionsReceived (int val)
	Get/Set the number of interactions received. More...
int	interactionsSent () const
	Get/Set the number of interactions sent. More...
void	setInteractionsSent (int val)
	Get/Set the number of interactions sent. More...
int	objectsOwned () const
	Get/Set the number of objects owned. More...
void	setObjectsOwned (int val)
	Get/Set the number of objects owned. More...
int	objectsUpdated () const
	Get/Set the number of objects updated. More...
void	setObjectsUpdated (int val)
	Get/Set the number of objects updated. More...
int	objectsReflected () const
	Get/Set the number of objects reflected. More...
void	setObjectsReflected (int val)
	Get/Set the number of objects reflected. More...
Public Member Functions inherited from DtStateRepository
	DtStateRepository ()
	default constructor More...
	DtStateRepository (const DtStateRepository &orig)
	copy constructor More...
virtual	~DtStateRepository ()
	destructor More...
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator More...
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name. More...
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle. More...
virtual const DtObjectId &	localId () const
virtual bool	publishesAttribute (const RTI::AttributeHandle &val) const
	Returns true if the attribute is published. More...
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle. More...
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle. More...
virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
	Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject. More...
virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
	Get a pointer to attribute value for the attribute with the given name. More...
virtual const char *	getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it. More...
virtual DtStateRepositoryExtension *	stateRepositoryExtension (DtString srExtName) const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
virtual std::vector< DtString >	stateRepositoryExtensionNames () const
	Returns a set of the registered state repository extension names. More...
virtual void	setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
virtual const std::map < DtString, DtStateRepositoryExtension * >	stateRepositoryExtensions () const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...

Static Public Member Functions
static DtFederateStateRepository *	create ()
	Create a DtFederateStateRepository. More...
Static Public Member Functions inherited from DtStateRepository
static bool	addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
	The following functions are for extending state repositories through State Repository Extension classes. More...

Protected Attributes
RTI::FederateHandle	myFederateHandle
DtString	myFederateType
DtString	myFederateHost
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
DtExerciseConn *	myExConn

Additional Inherited Members
Public Attributes inherited from DtStateRepository
DtString	myGlobalId
DtObjectId	myLocalId
std::map< RTI::AttributeHandle, DtGenericAttributeInfo * >	myAttributesByHandle
	Attributes by handle. More...
DtStateRepositoryExtensionMap	myStateRepositoryExtensionMap
Static Public Attributes inherited from DtStateRepository
static std::map< DtString, DtSrExtCreatorFnc >	theStateRepositoryExtensionCreatorMap

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.

Reimplemented from DtStateRepository.

static DtFederateStateRepository* DtFederateStateRepository::create ( )

static

Create a DtFederateStateRepository.

DtExerciseConn* DtFederateStateRepository::exConn ( ) const

inline

Used for correct decoding of handles.

This is set in the reflected constructor and should not be modified unless you know what you are doing.

const RTI::FederateHandle& DtFederateStateRepository::federateHandle

(

)

const

Get/Set the Federate Handle.

const DtString& DtFederateStateRepository::federateHost

(

)

const

Get/Set the Federate Host.

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.

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.

Reimplemented from 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::setExConn ( DtExerciseConn *  val )

inline

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::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::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

DtExerciseConn* DtFederateStateRepository::myExConn

protected

RTI::FederateHandle DtFederateStateRepository::myFederateHandle

protected

DtString DtFederateStateRepository::myFederateHost

protected

DtString DtFederateStateRepository::myFederateState

protected

DtString DtFederateStateRepository::myFederateTime

protected

DtString DtFederateStateRepository::myFederateType

protected

DtString DtFederateStateRepository::myFedId

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:

• federateStateRepository.h