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 )

References myLocalFederates.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::clearLocalFederates ( )

References myLocalFederates.

MAKRti::DtString DtRtiAssociatedConnectionData::conflictReason ( ) const

Get/set conflict reason.

References myConflictReason.

DtRtiAssociatedConnectionData::DtConnectionState DtRtiAssociatedConnectionData::connectionState ( ) const

Get/set state.

References myConnectionState.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

int DtRtiAssociatedConnectionData::forwarderCompId ( ) const

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

References myForwarderCompId.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

DtAssistantInfo DtRtiAssociatedConnectionData::forwardersAssistant ( ) const

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

References myForwardersAssistant.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

bool DtRtiAssociatedConnectionData::isChosen ( ) const

Get/set whether connection is chosen.

References myIsChosen.

bool DtRtiAssociatedConnectionData::isNamed ( ) const

Reterns true if there is a name set.

References myName.

bool DtRtiAssociatedConnectionData::isPredefined ( ) const

Get/set whether connection is predefined.

References myIsPredefined.

bool DtRtiAssociatedConnectionData::isSaved ( ) const

Get/set whether connection is saved.

References myIsSaved.

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

References myLocalFederates.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

MAKRti::DtString DtRtiAssociatedConnectionData::name ( bool withOwner = false ) const

Get name.

References myName, and myOwnerHost.

unsigned DtRtiAssociatedConnectionData::numLocalFederates ( ) const

Get/set number of local federates using connection.

References myLocalFederates.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

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

virtual

Not equals operator.

References operator==().

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

virtual

Equals operator.

References myConflictReason, myConnectionState, myForwarderCompId, myForwardersAssistant, myIsChosen, myIsPredefined, myIsSaved, myName, myOptionalAdditionalForwarderToConnectTo, myRtiexecCompId, myRtiexecsAssistant, myRtiexecWasRemotelyHeartbeated, and myWasRemotelyHeartbeated.

Referenced by operator!=().

MAKRti::DtInetAddr DtRtiAssociatedConnectionData::optionalForwarderToConnectTo ( ) const

Get/set forwarder to connect to.

References myOptionalAdditionalForwarderToConnectTo.

MAKRti::DtString DtRtiAssociatedConnectionData::ownerHost ( ) const

Get/set owner host machine.

References myOwnerHost.

void DtRtiAssociatedConnectionData::removeLocalFederate ( int compId )

References myLocalFederates.

int DtRtiAssociatedConnectionData::rtiexecCompId ( ) const

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

References myRtiexecCompId.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

DtAssistantInfo DtRtiAssociatedConnectionData::rtiexecsAssistant ( ) const

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

References myRtiexecsAssistant.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setConflictReason ( const MAKRti::DtString & reason )

References myConflictReason.

void DtRtiAssociatedConnectionData::setConnectionState ( DtRtiAssociatedConnectionData::DtConnectionState state )

References myConnectionState.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), DtConnectionCache::getRtiexecConnectionsFromEnv(), and DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setForwarderCompId ( int id )

References myForwarderCompId.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setForwardersAssistant ( const DtAssistantInfo & assistant )

References myForwardersAssistant.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setIsChosen ( bool chosen )

References myIsChosen.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), and DtConnectionCache::getRtiexecConnectionsFromEnv().

void DtRtiAssociatedConnectionData::setIsPredefined ( bool predefined )

References myIsPredefined.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), and DtConnectionCache::getRtiexecConnectionsFromEnv().

void DtRtiAssociatedConnectionData::setIsSaved ( bool saved )

References myIsSaved.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), DtConnectionCache::getRtiexecConnectionsFromEnv(), and DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setName ( const MAKRti::DtString & connName )

Set name.

References myName.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), and DtConnectionCache::getRtiexecConnectionsFromEnv().

void DtRtiAssociatedConnectionData::setOptionalForwarderToConnectTo ( const MAKRti::DtInetAddr & forwarder )

References myOptionalAdditionalForwarderToConnectTo.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), and DtConnectionCache::getRtiexecConnectionsFromEnv().

void DtRtiAssociatedConnectionData::setOwnerHost ( const MAKRti::DtString & host )

References myOwnerHost.

Referenced by DtConnectionCache::getLightweightConnectionsFromEnv(), DtConnectionCache::getRtiexecConnectionsFromEnv(), and DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setRtiexecCompId ( int id )

References myRtiexecCompId.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setRtiexecsAssistant ( const DtAssistantInfo & assistant )

References myRtiexecsAssistant.

Referenced by DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

void DtRtiAssociatedConnectionData::setWasRemotelyHeartbeated ( bool heartbeated )

References myWasRemotelyHeartbeated.

void DtRtiAssociatedConnectionData::setWasRtiexecRemotelyHeartbeated ( bool heartbeated )

References myRtiexecWasRemotelyHeartbeated.

bool DtRtiAssociatedConnectionData::wasRemotelyHeartbeated ( ) const

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

References myWasRemotelyHeartbeated.

bool DtRtiAssociatedConnectionData::wasRtiexecRemotelyHeartbeated ( ) const

Get/set whether rtiexec was recently remotely heartbeated.

References myRtiexecWasRemotelyHeartbeated.

Member Data Documentation

MAKRti::DtString DtRtiAssociatedConnectionData::myConflictReason

protected

Referenced by conflictReason(), operator==(), and setConflictReason().

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 connectionState(), isStateActive(), isStateConflicting(), isStateForwarderVerified(), isStateInactive(), isStateUnknown(), isStateVerified(), operator==(), and setConnectionState().