MAK RTIspy API Documentation for HLA 4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | 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:

Public Types

typedef std::map
< DtRtiConnectionInfo,
DtRtiConnectionConfigurationInfo
DtRtiConnAndConfigMap
 

Public Member Functions

 DtRtiConnectionAndConfiguration ()
 Default CTOR. More...
 
 DtRtiConnectionAndConfiguration (const DtRtiConnectionAndConfiguration &other)
 Copy CTOR. More...
 
virtual ~DtRtiConnectionAndConfiguration ()
 Virtual DTOR. More...
 
virtual
DtRtiConnectionAndConfiguration
operator= (const DtRtiConnectionAndConfiguration &other)
 Assignment operator. More...
 
virtual unsigned int size () const
 
virtual bool addConfiguration (const DtRtiConfigurationInfoDataPair &config)
 If config is unknown store it and return whether it was stored. More...
 
virtual bool removeConfiguration (const DtRtiConnectionConfigurationInfo &config)
 If config is known, remove it and return whether it was removed. More...
 
virtual bool addConnection (const DtRtiConnectionInfoDataPair &conn)
 If connection is unknown store it and return whether it was stored. More...
 
virtual bool removeConnection (const DtRtiConnectionInfo &conn)
 If connection is known, remove it and return whether it was removed. More...
 
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. More...
 
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. More...
 
virtual bool updateConfiguration (const DtRtiConfigurationInfoDataPair &config)
 Replace the existing configuration with the new associated data. More...
 
virtual void setConnectionConfigMapping (const DtRtiConnectionInfo &conn, const DtRtiConnectionConfigurationInfo &config)
 Add or changes the configuration that is mapped to the connection. More...
 
virtual void removeConnectionConfigMapping (const DtRtiConnectionInfo &conn)
 Remove mapping between a connection and its configuration. More...
 
virtual bool findConfigMapping (const DtRtiConnectionInfo &conn, DtRtiConfigurationInfoDataPair &config) const
 Find the configuration associated with the given connection. More...
 
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. More...
 
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. More...
 
virtual int numberOfEntriesWithName (const MAKRti::DtString &name) const
 Returns the number of entries with the given name. More...
 
virtual bool findConnectionWithMatchingNameAndOwner (DtRtiConnectionInfoDataPair &conn)
 Finds the connection with the matching name and owner with the given one. More...
 
virtual void clearAllInfo ()
 Clears all connections, configurations, and mappings. More...
 
virtual bool findConnection (DtRtiConnectionInfoDataPair &conn) const
 Find the first connection that's compatible with conn. More...
 
virtual bool getRtiExecConnectionData (const DtRtiConnectionInfo &conn, DtRtiConnectionInfoDataPair &rtiExecConn) const
 Find a connection data that is hosting an active rtiexec component and whose address and port matches the given connection Return true if the connection data was found; otherwise, false. More...
 
virtual bool findConfiguration (DtRtiConfigurationInfoDataPair &config) const
 Find the first configuration that's compatible. More...
 
virtual void clearAllSaved ()
 For all connections set their saved status to false (if they're either verified or forwarderVerified). More...
 
virtual bool getChosenConnection (DtRtiConnectionInfoDataPair &conn)
 Retrieves the chosen connection, or returns false if nothing has been chosen. More...
 
virtual bool getChosenConfiguration (DtRtiConfigurationInfoDataPair &config)
 Retrieves the chosen configuration, or returns false if nothing has been chosen. More...
 
virtual const
DtRtiConnectionInfoDataMap
connections () const
 Returns the full set of connections. More...
 
virtual const
DtRtiConfigurationInfoDataMap
configs () const
 Returns the full set of configurations. More...
 
virtual const
DtRtiConnAndConfigMap
connToConfigMap () const
 Returns the full set of configurations. More...
 
virtual const
DtRemoteAssistantSet
foreignAssistants () const
 Returns the full set of foreign assistant connections. More...
 
virtual bool updateLocalInterface (const MAKRti::DtString &hostName, const DtInetAddr &localInterface, DtRtiConnectionAndConfiguration &updatedConns)
 Update local interface for connections with the given host. Add updated connections to set. More...
 
Comparison operators.
virtual bool operator< (const DtRtiConnectionAndConfiguration &other) const
 
virtual bool operator== (const DtRtiConnectionAndConfiguration &other) const
 
virtual bool operator!= (const DtRtiConnectionAndConfiguration &other) const
 
Foreign assistant addition methods.

Add a foreign assistant host

virtual bool addForeignAssistant (const DtAssistantConnectionStruct &assistant)
 
virtual bool addRemoteForeignAssistant (const DtAssistantConnectionStruct &assistant, DtAssistantConnectionStruct &old)
 
Foreign assistant removal methods.

Remove a foreign assistant host

virtual void removeForeignAssistant (const DtAssistantConnectionStruct &assistant)
 

Protected Types

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

Protected Member Functions

virtual
DtRtiConnectionInfoDataMap::iterator 
replaceConnection (DtRtiConnectionInfoDataMap::iterator const &oldConnIter, DtRtiConnectionInfoDataPair &newConn)
 Replace the old connection with the new connection adjusting chosen connection if necessary. More...
 
virtual void removeChosenConnection ()
 Removes the current chosen designation. More...
 
virtual void removeChosenConfiguration ()
 Removes the current chosen designation. More...
 

Protected Attributes

DtRtiConnAndConfigMap myConnsAndConfigs
 
DtRtiConnectionInfoDataMap myConns
 
DtRtiConfigurationInfoDataMap myConfigs
 
DtAssistantSetByAddresses myPendingForeignAssistants
 
DtRemoteAssistantSet myForeignAssistants
 
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

DtRtiConnectionAndConfiguration::DtRtiConnectionAndConfiguration ( )

Default CTOR.

DtRtiConnectionAndConfiguration::DtRtiConnectionAndConfiguration ( const DtRtiConnectionAndConfiguration other)

Copy CTOR.

virtual DtRtiConnectionAndConfiguration::~DtRtiConnectionAndConfiguration ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual bool DtRtiConnectionAndConfiguration::addConfiguration ( const DtRtiConfigurationInfoDataPair config)
virtual

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

virtual bool DtRtiConnectionAndConfiguration::addConnection ( const DtRtiConnectionInfoDataPair conn)
virtual

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

virtual bool DtRtiConnectionAndConfiguration::addForeignAssistant ( const DtAssistantConnectionStruct assistant)
virtual
virtual bool DtRtiConnectionAndConfiguration::addRemoteForeignAssistant ( const DtAssistantConnectionStruct assistant,
DtAssistantConnectionStruct old 
)
virtual
virtual void DtRtiConnectionAndConfiguration::clearAllInfo ( )
virtual

Clears all connections, configurations, and mappings.

virtual void DtRtiConnectionAndConfiguration::clearAllSaved ( )
virtual

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

virtual const DtRtiConfigurationInfoDataMap& DtRtiConnectionAndConfiguration::configs ( ) const
inlinevirtual

Returns the full set of configurations.

virtual const DtRtiConnectionInfoDataMap& DtRtiConnectionAndConfiguration::connections ( ) const
inlinevirtual

Returns the full set of connections.

virtual const DtRtiConnAndConfigMap& DtRtiConnectionAndConfiguration::connToConfigMap ( ) const
inlinevirtual

Returns the full set of configurations.

virtual bool DtRtiConnectionAndConfiguration::findConfigMapping ( const DtRtiConnectionInfo conn,
DtRtiConfigurationInfoDataPair config 
) const
virtual

Find the configuration associated with the given connection.

virtual bool DtRtiConnectionAndConfiguration::findConfiguration ( DtRtiConfigurationInfoDataPair config) const
virtual

Find the first configuration that's compatible.

Returns the found configuration, including its associated data

virtual bool DtRtiConnectionAndConfiguration::findConnection ( DtRtiConnectionInfoDataPair conn) const
virtual

Find the first connection that's compatible with conn.

Returns the found connection, including its associated data

virtual bool DtRtiConnectionAndConfiguration::findConnectionWithMatchingNameAndOwner ( DtRtiConnectionInfoDataPair conn)
virtual

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

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

virtual const DtRemoteAssistantSet& DtRtiConnectionAndConfiguration::foreignAssistants ( ) const
inlinevirtual

Returns the full set of foreign assistant connections.

virtual bool DtRtiConnectionAndConfiguration::getChosenConfiguration ( DtRtiConfigurationInfoDataPair config)
virtual

Retrieves the chosen configuration, or returns false if nothing has been chosen.

virtual bool DtRtiConnectionAndConfiguration::getChosenConnection ( DtRtiConnectionInfoDataPair conn)
virtual

Retrieves the chosen connection, or returns false if nothing has been chosen.

virtual bool DtRtiConnectionAndConfiguration::getRtiExecConnectionData ( const DtRtiConnectionInfo conn,
DtRtiConnectionInfoDataPair rtiExecConn 
) const
virtual

Find a connection data that is hosting an active rtiexec component and whose address and port matches the given connection Return true if the connection data was found; otherwise, false.

virtual 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.

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

Returns the number of entries with the given name.

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

Assignment operator.

virtual bool DtRtiConnectionAndConfiguration::operator== ( const DtRtiConnectionAndConfiguration other) const
virtual
virtual void DtRtiConnectionAndConfiguration::removeChosenConfiguration ( )
protectedvirtual

Removes the current chosen designation.

virtual void DtRtiConnectionAndConfiguration::removeChosenConnection ( )
protectedvirtual

Removes the current chosen designation.

virtual bool DtRtiConnectionAndConfiguration::removeConfiguration ( const DtRtiConnectionConfigurationInfo config)
virtual

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

virtual bool DtRtiConnectionAndConfiguration::removeConnection ( const DtRtiConnectionInfo conn)
virtual

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

virtual void DtRtiConnectionAndConfiguration::removeConnectionConfigMapping ( const DtRtiConnectionInfo conn)
virtual

Remove mapping between a connection and its configuration.

virtual void DtRtiConnectionAndConfiguration::removeForeignAssistant ( const DtAssistantConnectionStruct assistant)
virtual
virtual DtRtiConnectionInfoDataMap::iterator DtRtiConnectionAndConfiguration::replaceConnection ( DtRtiConnectionInfoDataMap::iterator const &  oldConnIter,
DtRtiConnectionInfoDataPair newConn 
)
protectedvirtual

Replace the old connection with the new connection adjusting chosen connection if necessary.

Return the iterator to the new connection.

virtual void DtRtiConnectionAndConfiguration::setConnectionConfigMapping ( const DtRtiConnectionInfo conn,
const DtRtiConnectionConfigurationInfo config 
)
virtual

Add or changes the configuration that is mapped to the connection.

If another mapping already exists for the connection, it is removed before adding the new one.

virtual unsigned int DtRtiConnectionAndConfiguration::size ( ) const
inlinevirtual
virtual bool DtRtiConnectionAndConfiguration::updateConfiguration ( const DtRtiConfigurationInfoDataPair config)
virtual

Replace the existing configuration with the new associated data.

virtual bool DtRtiConnectionAndConfiguration::updateConnection ( DtRtiConnectionInfoDataPair conn)
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.

virtual bool DtRtiConnectionAndConfiguration::updateConnectionAssociatedDataOnly ( DtRtiConnectionInfoDataPair conn)
virtual

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.

Does not update any host info for the stored connection.

virtual bool DtRtiConnectionAndConfiguration::updateLocalInterface ( const MAKRti::DtString &  hostName,
const DtInetAddr &  localInterface,
DtRtiConnectionAndConfiguration updatedConns 
)
virtual

Update local interface for connections with the given host. Add updated connections to set.

virtual 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.

Member Data Documentation

DtRtiConfigurationInfoDataMap::iterator DtRtiConnectionAndConfiguration::myChosenConfiguration
protected
DtRtiConnectionInfoDataMap::iterator DtRtiConnectionAndConfiguration::myChosenConnection
protected
DtRtiConfigurationInfoDataMap DtRtiConnectionAndConfiguration::myConfigs
protected
bool DtRtiConnectionAndConfiguration::myConfigurationIsChosen
protected
bool DtRtiConnectionAndConfiguration::myConnectionIsChosen
protected
DtNameAndOwnerMap DtRtiConnectionAndConfiguration::myConnNames
protected
DtRtiConnectionInfoDataMap DtRtiConnectionAndConfiguration::myConns
protected
DtRtiConnAndConfigMap DtRtiConnectionAndConfiguration::myConnsAndConfigs
protected
DtRemoteAssistantSet DtRtiConnectionAndConfiguration::myForeignAssistants
protected
DtAssistantSetByAddresses DtRtiConnectionAndConfiguration::myPendingForeignAssistants
protected

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

Document ID: Generated on Wed Jul 8 16:20:32 EDT 2026 from SVN revision 291616
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)