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 ()
	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

typedef std::map<DtRtiConnectionInfo, DtRtiConnectionConfigurationInfo> DtRtiConnectionAndConfiguration::DtRtiConnAndConfigMap

Constructor & Destructor Documentation

DtRtiConnectionAndConfiguration::DtRtiConnectionAndConfiguration

(

)

DtRtiConnectionAndConfiguration::DtRtiConnectionAndConfiguration

(

const DtRtiConnectionAndConfiguration &

)

DtRtiConnectionAndConfiguration::~DtRtiConnectionAndConfiguration

(

)

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 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 bool DtRtiConnectionAndConfiguration::getChosenConnAndConfig ( DtRtiConnectionInfoDataPair &  conn, DtRtiConfigurationInfoDataPair &  config  )

virtual

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

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 &  orig )

virtual

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

virtual

void DtRtiConnectionAndConfiguration::removeChosenDesignation ( )

protected

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.

void DtRtiConnectionAndConfiguration::setChosenConfigurationFromConnection ( )

protected

Sets the chosen configuration based on the current chosen 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::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

---

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

• connectionAndConfiguration.h