MAK RTIspy API Documentation for HLA 1516
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
DtRtiConnectionAndConfiguration Class Reference

Stores the information on an RTI connection and possibly matching configuration known by the Assistant. More...

+ Collaboration diagram for DtRtiConnectionAndConfiguration:

List of all members.

Public Types

typedef std::map
< DtRtiConnectionInfo,
DtRtiConnectionConfigurationInfo
DtRtiConnAndConfigMap

Public Member Functions

 DtRtiConnectionAndConfiguration ()
 DtRtiConnectionAndConfiguration (const DtRtiConnectionAndConfiguration &)
 ~DtRtiConnectionAndConfiguration ()
virtual
DtRtiConnectionAndConfiguration
operator= (const DtRtiConnectionAndConfiguration &orig)
virtual bool operator< (const DtRtiConnectionAndConfiguration &other) const
virtual bool operator== (const DtRtiConnectionAndConfiguration &other) const
virtual bool operator!= (const DtRtiConnectionAndConfiguration &other) const
virtual unsigned int size () const
virtual bool addConfiguration (const DtRtiConfigurationInfoDataPair &config)
 If config is unknown store it and return whether it was stored.
virtual bool removeConfiguration (const DtRtiConnectionConfigurationInfo &config)
 If config is known, remove it and return whether it was removed.
virtual bool addConnection (const DtRtiConnectionInfoDataPair &conn)
 If connection is unknown store it and return whether it was stored.
virtual bool removeConnection (const DtRtiConnectionInfo &conn)
 If connection is known, remove it and return whether it was removed.
virtual bool updateConnection (DtRtiConnectionInfoDataPair &conn)
 Update the existing connection with with the new associated data as well as ensuring that both conn and the stored connection have the most complete host information.
virtual bool updateConnectionAssociatedDataOnly (DtRtiConnectionInfoDataPair &conn)
 Update the existing connection with with the new associated data as well as ensuring that the passed in conn has the most complete host info.
virtual bool updateConfiguration (const DtRtiConfigurationInfoDataPair &config)
 Replace the existing configuration with the new associated data.
virtual void setConnectionConfigMapping (const DtRtiConnectionInfo &conn, const DtRtiConnectionConfigurationInfo &config)
 Add or changes the configuration that is mapped to the connection.
virtual void removeConnectionConfigMapping (const DtRtiConnectionInfo &conn)
 Remove mapping between a connection and its configuration.
virtual bool findConfigMapping (const DtRtiConnectionInfo &conn, DtRtiConfigurationInfoDataPair &config) const
 Find the configuration associated with the given connection.
virtual bool willConflict (const DtRtiConnectionInfo &compare, MAKRti::DtString &reason) const
 Determines if there are any active connections in this list that will conflict with the given one.
virtual bool nameAndOwnerExists (const MAKRti::DtString &name, const MAKRti::DtString &owner) const
 Checks the list to see if a connection with this name and owning host name is present, and returns true if it is.
virtual int numberOfEntriesWithName (const MAKRti::DtString &name) const
 Returns the number of entries with the given name.
virtual bool findConnectionWithMatchingNameAndOwner (DtRtiConnectionInfoDataPair &conn)
 Finds the connection with the matching name and owner with the given one.
virtual void clearAllInfo ()
 Clears all connections, configurations, and mappings.
virtual bool findConnection (DtRtiConnectionInfoDataPair &conn) const
 Find the first connection that's compatible with conn.
virtual bool findConfiguration (DtRtiConfigurationInfoDataPair &config) const
 Find the first configuration that's compatible.
virtual void clearAllSaved ()
 For all connections set their saved status to false (if they're either verified or forwarderVerified).
virtual bool getChosenConnAndConfig (DtRtiConnectionInfoDataPair &conn, DtRtiConfigurationInfoDataPair &config)
 Retrieves the chosen connection and configuration, or returns false if nothing has been chosen.
virtual const
DtRtiConnectionInfoDataMap
connections () const
 Returns the full set of connections.
virtual const
DtRtiConfigurationInfoDataMap
configs () const
 Returns the full set of configurations.
virtual const
DtRtiConnAndConfigMap
connToConfigMap () const
 Returns the full set of configurations.

Protected Types

typedef std::map< std::pair
< MAKRti::DtString,
MAKRti::DtString >
, DtRtiConnectionInfoDataMap::iterator > 
DtNameAndOwnerMap

Protected Member Functions

void removeChosenDesignation ()
 Removes the current chosen designation.
void setChosenConfigurationFromConnection ()
 Sets the chosen configuration based on the current chosen connection.

Protected Attributes

DtRtiConnAndConfigMap myConnsAndConfigs
DtRtiConnectionInfoDataMap myConns
DtRtiConfigurationInfoDataMap myConfigs
DtNameAndOwnerMap myConnNames
DtRtiConnectionInfoDataMap::iterator myChosenConnection
DtRtiConfigurationInfoDataMap::iterator myChosenConfiguration
bool myConnectionIsChosen
bool myConfigurationIsChosen

Detailed Description

Stores the information on an RTI connection and possibly matching configuration known by the Assistant.


Member Typedef Documentation

typedef std::map<std::pair<MAKRti::DtString,MAKRti::DtString>, DtRtiConnectionInfoDataMap::iterator> DtRtiConnectionAndConfiguration::DtNameAndOwnerMap [protected]

Constructor & Destructor Documentation


Member Function Documentation

If connection is unknown store it and return whether it was stored.

References myChosenConnection, myConnectionIsChosen, myConnNames, myConns, and removeChosenDesignation().

Referenced by DtAssistantConnectionInfoMgr::addListedRtiexecsForwardersForAssistant(), DtAssistantConnectionInfoMgr::addUserDefinedConnections(), DtAssistantConnectionInfoMgr::checkForConflictingConns(), DtAssistantConnQueryMgr::checkForConflictingUnsavedConns(), DtConnectionCache::getLightweightConnectionsFromEnv(), DtAssistantLightweightInfoMsg::getLightweightConns(), DtConnectionCache::getRtiexecConnectionsFromEnv(), DtAssistantInfoMsg::getRtiexecsAndForwarders(), DtAssistantConnectionInfoMgr::processClearChosenConnection(), DtAssistantConnectionInfoMgr::processLightweightInfoMsg(), DtAssistantConnectionInfoMgr::processLocalForwarderHasNoRtiexec(), DtAssistantConnectionInfoMgr::processLocalForwarderHasRtiexec(), DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected(), DtAssistantConnectionInfoMgr::processLocalRtiComponentNotConnected(), DtAssistantConnectionInfoMgr::processNewChosenConnection(), DtAssistantConnQueryMgr::processNewUserAddedConnection(), DtAssistantConnectionInfoMgr::processStartRtiexecMsg(), DtAssistantConnectionInfoMgr::pruneStaleAssistantsExecsFwrdrs(), DtAssistantConnectionInfoMgr::pruneStaleLightweightConns(), DtAssistantConnectionInfoMgr::removeAllLocalRtiexecsForwarders(), DtAssistantConnectionInfoMgr::removeUserDeletedConnections(), DtRtiAssistantPeer::sendLightweightInfoMsg(), DtAssistantConnectionInfoMgr::setInterfaceForPredefinedConns(), DtAssistantConnQueryMgr::startRtiexec(), DtAssistantConnQueryWidget::storeUserAddedConnection(), DtAssistantConnQueryWidget::storeUserRemovedConnection(), DtAssistantConnectionInfoMgr::unverifyListedRtiexecsForwardersForAssistant(), and DtAssistantConnectionInfoMgr::unverifyRtiexecsForwardersForAssistant().

For all connections set their saved status to false (if they're either verified or forwarderVerified).

References myConfigurationIsChosen, myConnectionIsChosen, myConns, and myConnsAndConfigs.

virtual const DtRtiConfigurationInfoDataMap& DtRtiConnectionAndConfiguration::configs ( ) const [inline, virtual]

Returns the full set of configurations.

Referenced by DtRtiConnectionAndConfiguration(), operator<(), operator=(), operator==(), and DtConnectionCache::setConnections().

Returns the full set of connections.

Referenced by DtAssistantConnQueryWidget::addConnections(), DtAssistantConnectionInfoMgr::addListedRtiexecsForwardersForAssistant(), DtAssistantConnectionInfoMgr::addUserDefinedConnections(), DtAssistantConnectionInfoMgr::checkForConflictingConns(), DtAssistantConnQueryMgr::checkForConflictingUnsavedConns(), DtRtiConnectionAndConfiguration(), DtConnectionCache::getConfigurationsFromEnv(), operator<(), operator=(), operator==(), DtAssistantLatencyTestMgr::processConnectionsRemoval(), DtAssistantNetworkCompInfoMgr::processConnectionsRemoval(), DtAssistantFederationsViewMgr::processConnectionsRemoval(), DtAssistantFederationsInfoMgr::processConnectionsRemoval(), DtAssistantLatencyTestMgr::processConnectionsUpdate(), DtAssistantNetworkCompInfoMgr::processConnectionsUpdate(), DtAssistantFederationsViewMgr::processConnectionsUpdate(), DtAssistantFederationsInfoMgr::processConnectionsUpdate(), DtAssistantConnectionInfoMgr::processLightweightInfoMsg(), DtAssistantConnectionInfoMgr::pruneStaleAssistantsExecsFwrdrs(), DtAssistantConnectionInfoMgr::pruneStaleLightweightConns(), DtAssistantConnectionInfoMgr::removeAllLocalLightweightConns(), DtAssistantConnectionInfoMgr::removeAllLocalRtiexecsForwarders(), DtAssistantConnQueryWidget::removeConnections(), DtAssistantConnectionInfoMgr::removeConnections(), DtAssistantConnectionInfoMgr::removeUserDeletedConnections(), DtRtiAssistantPeer::sendInfoMsg(), DtRtiAssistantPeer::sendLightweightInfoMsg(), DtConnectionCache::setConnections(), DtAssistantConnectionInfoMgr::setInterfaceForPredefinedConns(), DtAssistantLightweightInfoMsg::setLightweightConns(), DtAssistantInfoMsg::setRtiexecsAndForwarders(), and DtAssistantConnectionInfoMgr::unverifyListedRtiexecsForwardersForAssistant().

virtual const DtRtiConnAndConfigMap& DtRtiConnectionAndConfiguration::connToConfigMap ( ) const [inline, virtual]

Returns the full set of configurations.

Referenced by DtRtiConnectionAndConfiguration(), operator<(), operator=(), and operator==().

Find the first configuration that's compatible.

Returns the found configuration, including its associated data

References myConfigs.

Referenced by findConfigMapping(), DtAssistantConnectionInfoMgr::processLocalForwarderHasRtiexec(), DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected(), and DtAssistantConnectionInfoMgr::processNewChosenConnection().

Find the first connection that's compatible with conn.

Returns the found connection, including its associated data

References myConns.

Referenced by DtAssistantConnQueryWidget::addConnections(), DtAssistantConnectionInfoMgr::addListedRtiexecsForwardersForAssistant(), DtAssistantConnectionInfoMgr::addUserDefinedConnections(), DtAssistantConnectionInfoMgr::connectionName(), DtAssistantConnectionInfoMgr::getConnectionInfo(), DtConnectionCache::getLightweightConnectionsFromEnv(), DtAssistantConnectionInfoMgr::getRemoteForwarderConnInfo(), DtAssistantConnectionInfoMgr::getRemoteRtiexecConnInfo(), DtAssistantConnectionInfoMgr::getRemoteRtiexecLocation(), DtAssistantConnectionInfoMgr::getRemoteRtiForwarderLocation(), DtConnectionCache::getRtiexecConnectionsFromEnv(), DtAssistantConnectionInfoMgr::localRtiexecCompId(), DtAssistantConnectionInfoMgr::localRtiForwarderCompId(), DtAssistantConnectionInfoMgr::processLightweightInfoMsg(), DtAssistantConnectionInfoMgr::processLocalForwarderHasNoRtiexec(), DtAssistantConnectionInfoMgr::processLocalForwarderHasRtiexec(), DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected(), DtAssistantConnectionInfoMgr::processLocalRtiComponentNotConnected(), DtAssistantConnectionInfoMgr::processNewChosenConnection(), DtAssistantConnQueryWidget::removeConnections(), DtAssistantConnectionInfoMgr::removeUserDeletedConnections(), DtAssistantConnectionInfoMgr::unverifyListedRtiexecsForwardersForAssistant(), and DtAssistantConnectionInfoMgr::unverifyRtiexecsForwardersForAssistant().

Finds the connection with the matching name and owner with the given one.

Returns true if the connection was found and could be replaced.

References myConnNames.

Referenced by DtAssistantConnectionInfoMgr::addListedRtiexecsForwardersForAssistant(), DtAssistantConnectionInfoMgr::processLightweightInfoMsg(), and DtAssistantConnectionInfoMgr::processStartRtiexecMsg().

bool DtRtiConnectionAndConfiguration::nameAndOwnerExists ( const MAKRti::DtString &  name,
const MAKRti::DtString &  owner 
) const [virtual]

Checks the list to see if a connection with this name and owning host name is present, and returns true if it is.

References myConnNames.

int DtRtiConnectionAndConfiguration::numberOfEntriesWithName ( const MAKRti::DtString &  name) const [virtual]

Returns the number of entries with the given name.

References myConnNames.

Referenced by DtAssistantConnectionInfoMgr::connectionName().

bool DtRtiConnectionAndConfiguration::operator!= ( const DtRtiConnectionAndConfiguration other) const [virtual]
bool DtRtiConnectionAndConfiguration::operator< ( const DtRtiConnectionAndConfiguration other) const [virtual]
DtRtiConnectionAndConfiguration & DtRtiConnectionAndConfiguration::operator= ( const DtRtiConnectionAndConfiguration orig) [virtual]
bool DtRtiConnectionAndConfiguration::operator== ( const DtRtiConnectionAndConfiguration other) const [virtual]

If config is known, remove it and return whether it was removed.

References myChosenConfiguration, myConfigs, myConfigurationIsChosen, and myConnsAndConfigs.

Sets the chosen configuration based on the current chosen connection.

References myChosenConfiguration, myChosenConnection, myConfigs, myConfigurationIsChosen, and myConnsAndConfigs.

Referenced by updateConnection(), and updateConnectionAssociatedDataOnly().

virtual unsigned int DtRtiConnectionAndConfiguration::size ( ) const [inline, virtual]

Update the existing connection with with the new associated data as well as ensuring that both conn and the stored connection have the most complete host information.

References myChosenConnection, myConnectionIsChosen, myConnNames, myConns, myConnsAndConfigs, removeChosenDesignation(), and setChosenConfigurationFromConnection().

Referenced by DtAssistantConnectionInfoMgr::addListedRtiexecsForwardersForAssistant(), and DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected().

bool DtRtiConnectionAndConfiguration::willConflict ( const DtRtiConnectionInfo compare,
MAKRti::DtString &  reason 
) const [virtual]

Determines if there are any active connections in this list that will conflict with the given one.

Sets a description of the reason for the conflict.

References DtRtiConnectionInfo::conflictsWith(), DtAssistantConnNameForDisplay(), and myConns.

Referenced by DtAssistantConnectionInfoMgr::addUserDefinedConnections(), DtAssistantConnectionInfoMgr::checkForConflictingConns(), DtAssistantConnectionInfoMgr::isConnConflicting(), and DtAssistantConnectionInfoMgr::processStartRtiexecMsg().


Member Data Documentation

DtRtiConfigurationInfoDataMap::iterator DtRtiConnectionAndConfiguration::myChosenConfiguration [protected]
DtRtiConnectionInfoDataMap::iterator DtRtiConnectionAndConfiguration::myChosenConnection [protected]

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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)