DtRtiAssociatedConnectionData Class Reference

Stores state information, user given name, and other data associated with a connection. More...

Collaboration diagram for DtRtiAssociatedConnectionData:

Public Types
enum	DtConnectionState { DtUnknownState, DtConnectionConflicting, DtConnectionForwarderVerified, DtConnectionVerified }

Public Member Functions
	DtRtiAssociatedConnectionData ()
	Constructor.
virtual bool	operator== (const DtRtiAssociatedConnectionData &other) const
	Equals operator.
virtual bool	operator!= (const DtRtiAssociatedConnectionData &other) const
	Not equals operator.
MAKRti::DtString	name (bool withOwner=false) const
	Get name.
void	setName (const MAKRti::DtString &connName)
	Set name.
bool	isNamed () const
	Reterns true if there is a name set.
MAKRti::DtString	ownerHost () const
	Get/set owner host machine.
void	setOwnerHost (const MAKRti::DtString &host)
DtConnectionState	connectionState () const
	Get/set state.
void	setConnectionState (DtConnectionState state)
MAKRti::DtString	conflictReason () const
	Get/set conflict reason.
void	setConflictReason (const MAKRti::DtString &reason)
bool	isSaved () const
	Get/set whether connection is saved.
void	setIsSaved (bool saved)
bool	isChosen () const
	Get/set whether connection is chosen.
void	setIsChosen (bool chosen)
bool	isPredefined () const
	Get/set whether connection is predefined.
void	setIsPredefined (bool predefined)
MAKRti::DtInetAddr	optionalForwarderToConnectTo () const
	Get/set forwarder to connect to.
void	setOptionalForwarderToConnectTo (const MAKRti::DtInetAddr &forwarder)
unsigned	numLocalFederates () const
	Get/set number of local federates using connection.
void	addLocalFederate (int compId)
void	removeLocalFederate (int compId)
void	clearLocalFederates ()
const std::set< int > &	localFederates () const
bool	wasRtiexecRemotelyHeartbeated () const
	Get/set whether rtiexec was recently remotely heartbeated.
void	setWasRtiexecRemotelyHeartbeated (bool heartbeated)
bool	wasRemotelyHeartbeated () const
	Get/set whether forwarder or lightweight federate was recently remotely heartbeated.
void	setWasRemotelyHeartbeated (bool heartbeated)
DtAssistantInfo	rtiexecsAssistant () const
	Get/set assistant that "owns" the rtiexec on this connection.
void	setRtiexecsAssistant (const DtAssistantInfo &assistant)
DtAssistantInfo	forwardersAssistant () const
	Get/set assistant that "owns" the forwarder on this connection.
void	setForwardersAssistant (const DtAssistantInfo &assistant)
int	rtiexecCompId () const
	Get/set the component ID of the rtiexec on this connection.
void	setRtiexecCompId (int id)
int	forwarderCompId () const
	Get/set the component ID of the forwarder on this connection.
void	setForwarderCompId (int id)
bool	isStateVerified () const
	Convenience functions for checking connection state.
bool	isStateForwarderVerified () const
	Convenience functions for checking connection state.
bool	isStateConflicting () const
	Convenience functions for checking connection state.
bool	isStateUnknown () const
	Convenience functions for checking connection state.
bool	isStateActive () const
	State is active if its is verified or forwarder verified.
bool	isStateInactive () const
	State is inactive if its is unknown or conflicting.

Protected Attributes
MAKRti::DtString	myName
	The user assigned name for the connection.
MAKRti::DtString	myOwnerHost
	The host name of the machine that created and owns the connection.
DtConnectionState	myConnectionState
	Whether or not this connection has been verified (by either this assistant or another being directly connected to the exec or forwarder) or is unknown or known to conflict.
MAKRti::DtString	myConflictReason
bool	myIsSaved
	Whether this connection has been/will be saved to file.
bool	myIsChosen
	Whether or not this connection is the chosen connection.
bool	myIsPredefined
	Whether or not this is one of the predefined connections.
MAKRti::DtInetAddr	myOptionalAdditionalForwarderToConnectTo
	If this connection is used to start a forwarder, that forwarder will try to connect to this optional forwarder.
std::set< int >	myLocalFederates
	The set of component IDs for all local federates on this conneciton.
bool	myRtiexecWasRemotelyHeartbeated
	Whether or not the rtiexec on this connection was recently remotely heartbeated.
bool	myWasRemotelyHeartbeated
	Whether or not a forwarder or lightweight federate on this connection was remotely heartbeated.
DtAssistantInfo	myRtiexecsAssistant
	The assistant that "owns" the rtiexec on this connection.
DtAssistantInfo	myForwardersAssistant
	The assistant that "owns" the forwarder on this connection.
int	myRtiexecCompId
	The component ID of the rtiexec using this connection.
int	myForwarderCompId
	The component ID of the forwarder using this connection.

Detailed Description

Stores state information, user given name, and other data associated with a connection.

Member Enumeration Documentation

enum DtRtiAssociatedConnectionData::DtConnectionState

Enumerator:

DtUnknownState
DtConnectionConflicting
DtConnectionForwarderVerified
DtConnectionVerified

Constructor & Destructor Documentation

DtRtiAssociatedConnectionData::DtRtiAssociatedConnectionData

(

)

Constructor.

Member Function Documentation

void DtRtiAssociatedConnectionData::addLocalFederate

(

int

compId

)

void DtRtiAssociatedConnectionData::clearLocalFederates

(

)

MAKRti::DtString DtRtiAssociatedConnectionData::conflictReason

(

)

const

Get/set conflict reason.

DtConnectionState DtRtiAssociatedConnectionData::connectionState

(

)

const

Get/set state.

int DtRtiAssociatedConnectionData::forwarderCompId

(

)

const

Get/set the component ID of the forwarder on this connection.

DtAssistantInfo DtRtiAssociatedConnectionData::forwardersAssistant

(

)

const

Get/set assistant that "owns" the forwarder on this connection.

bool DtRtiAssociatedConnectionData::isChosen

(

)

const

Get/set whether connection is chosen.

bool DtRtiAssociatedConnectionData::isNamed

(

)

const

Reterns true if there is a name set.

bool DtRtiAssociatedConnectionData::isPredefined

(

)

const

Get/set whether connection is predefined.

bool DtRtiAssociatedConnectionData::isSaved

(

)

const

Get/set whether connection is saved.

bool DtRtiAssociatedConnectionData::isStateActive ( ) const

inline

State is active if its is verified or forwarder verified.

References DtConnectionForwarderVerified, DtConnectionVerified, and myConnectionState.

bool DtRtiAssociatedConnectionData::isStateConflicting ( ) const

inline

Convenience functions for checking connection state.

References DtConnectionConflicting, and myConnectionState.

bool DtRtiAssociatedConnectionData::isStateForwarderVerified ( ) const

inline

Convenience functions for checking connection state.

References DtConnectionForwarderVerified, and myConnectionState.

bool DtRtiAssociatedConnectionData::isStateInactive ( ) const

inline

State is inactive if its is unknown or conflicting.

References DtConnectionConflicting, DtUnknownState, and myConnectionState.

bool DtRtiAssociatedConnectionData::isStateUnknown ( ) const

inline

Convenience functions for checking connection state.

References DtUnknownState, and myConnectionState.

bool DtRtiAssociatedConnectionData::isStateVerified ( ) const

inline

Convenience functions for checking connection state.

References DtConnectionVerified, and myConnectionState.

const std::set<int>& DtRtiAssociatedConnectionData::localFederates

(

)

const

MAKRti::DtString DtRtiAssociatedConnectionData::name

(

bool

withOwner = false

)

const

Get name.

unsigned DtRtiAssociatedConnectionData::numLocalFederates

(

)

const

Get/set number of local federates using connection.

virtual bool DtRtiAssociatedConnectionData::operator!= ( const DtRtiAssociatedConnectionData &  other ) const

virtual

Not equals operator.

virtual bool DtRtiAssociatedConnectionData::operator== ( const DtRtiAssociatedConnectionData &  other ) const

virtual

Equals operator.

MAKRti::DtInetAddr DtRtiAssociatedConnectionData::optionalForwarderToConnectTo

(

)

const

Get/set forwarder to connect to.

MAKRti::DtString DtRtiAssociatedConnectionData::ownerHost

(

)

const

Get/set owner host machine.

void DtRtiAssociatedConnectionData::removeLocalFederate

(

int

compId

)

int DtRtiAssociatedConnectionData::rtiexecCompId

(

)

const

Get/set the component ID of the rtiexec on this connection.

DtAssistantInfo DtRtiAssociatedConnectionData::rtiexecsAssistant

(

)

const

Get/set assistant that "owns" the rtiexec on this connection.

void DtRtiAssociatedConnectionData::setConflictReason

(

const MAKRti::DtString &

reason

)

void DtRtiAssociatedConnectionData::setConnectionState

(

DtConnectionState

state

)

void DtRtiAssociatedConnectionData::setForwarderCompId

(

int

id

)

void DtRtiAssociatedConnectionData::setForwardersAssistant

(

const DtAssistantInfo &

assistant

)

void DtRtiAssociatedConnectionData::setIsChosen

(

bool

chosen

)

void DtRtiAssociatedConnectionData::setIsPredefined

(

bool

predefined

)

void DtRtiAssociatedConnectionData::setIsSaved

(

bool

saved

)

void DtRtiAssociatedConnectionData::setName

(

const MAKRti::DtString &

connName

)

Set name.

void DtRtiAssociatedConnectionData::setOptionalForwarderToConnectTo

(

const MAKRti::DtInetAddr &

forwarder

)

void DtRtiAssociatedConnectionData::setOwnerHost

(

const MAKRti::DtString &

host

)

void DtRtiAssociatedConnectionData::setRtiexecCompId

(

int

id

)

void DtRtiAssociatedConnectionData::setRtiexecsAssistant

(

const DtAssistantInfo &

assistant

)

void DtRtiAssociatedConnectionData::setWasRemotelyHeartbeated

(

bool

heartbeated

)

void DtRtiAssociatedConnectionData::setWasRtiexecRemotelyHeartbeated

(

bool

heartbeated

)

bool DtRtiAssociatedConnectionData::wasRemotelyHeartbeated

(

)

const

Get/set whether forwarder or lightweight federate was recently remotely heartbeated.

bool DtRtiAssociatedConnectionData::wasRtiexecRemotelyHeartbeated

(

)

const

Get/set whether rtiexec was recently remotely heartbeated.

Member Data Documentation

MAKRti::DtString DtRtiAssociatedConnectionData::myConflictReason

protected

DtConnectionState DtRtiAssociatedConnectionData::myConnectionState

protected

Whether or not this connection has been verified (by either this assistant or another being directly connected to the exec or forwarder) or is unknown or known to conflict.

Referenced by isStateActive(), isStateConflicting(), isStateForwarderVerified(), isStateInactive(), isStateUnknown(), and isStateVerified().

int DtRtiAssociatedConnectionData::myForwarderCompId

protected

The component ID of the forwarder using this connection.

DtAssistantInfo DtRtiAssociatedConnectionData::myForwardersAssistant

protected

The assistant that "owns" the forwarder on this connection.

bool DtRtiAssociatedConnectionData::myIsChosen

protected

Whether or not this connection is the chosen connection.

bool DtRtiAssociatedConnectionData::myIsPredefined

protected

Whether or not this is one of the predefined connections.

bool DtRtiAssociatedConnectionData::myIsSaved

protected

Whether this connection has been/will be saved to file.

std::set<int> DtRtiAssociatedConnectionData::myLocalFederates

protected

The set of component IDs for all local federates on this conneciton.

MAKRti::DtString DtRtiAssociatedConnectionData::myName

protected

The user assigned name for the connection.

MAKRti::DtInetAddr DtRtiAssociatedConnectionData::myOptionalAdditionalForwarderToConnectTo

protected

If this connection is used to start a forwarder, that forwarder will try to connect to this optional forwarder.

MAKRti::DtString DtRtiAssociatedConnectionData::myOwnerHost

protected

The host name of the machine that created and owns the connection.

int DtRtiAssociatedConnectionData::myRtiexecCompId

protected

The component ID of the rtiexec using this connection.

DtAssistantInfo DtRtiAssociatedConnectionData::myRtiexecsAssistant

protected

The assistant that "owns" the rtiexec on this connection.

bool DtRtiAssociatedConnectionData::myRtiexecWasRemotelyHeartbeated

protected

Whether or not the rtiexec on this connection was recently remotely heartbeated.

bool DtRtiAssociatedConnectionData::myWasRemotelyHeartbeated

protected

Whether or not a forwarder or lightweight federate on this connection was remotely heartbeated.

---

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

• assistantConnectionAssocData.h