DtRtiConnectionConfigurationInfo Class Reference

Stores the information on an RTI configuration known by the Assistant. More...

Collaboration diagram for DtRtiConnectionConfigurationInfo:

Public Member Functions
	DtRtiConnectionConfigurationInfo ()
	Constructor. More...
	DtRtiConnectionConfigurationInfo (bool forceFullCompliance)
	Constructor. More...
virtual	~DtRtiConnectionConfigurationInfo ()
	Destructor. More...
virtual bool	operator< (const DtRtiConnectionConfigurationInfo &other) const
	Less than operator. More...
virtual bool	operator== (const DtRtiConnectionConfigurationInfo &other) const
	Equals operator. More...
virtual bool	operator!= (const DtRtiConnectionConfigurationInfo &other) const
	Not equals operator. More...
virtual DtRtiConnectionConfigurationInfo &	operator= (const DtRtiConnectionConfigurationInfo &other)
	Assignment operator. More...
virtual MAKRti::DtString	defaultName () const
	Returns the default name of the configuration. More...
virtual MAKRti::DtString	description () const
	Returns a text description of this configuration. More...
virtual void	setForceFullCompliance (bool compliance)
	Sets whether this is a fully compliant configuration. More...
virtual bool	forceFullCompliance () const
	Gets whether this is a fully compliant configuration. More...
virtual void	setRidConfigurationName (const MAKRti::DtString &name)
virtual const MAKRti::DtString &	ridConfigurationName () const
virtual void	setRidIsPreconfigured (bool isPreconfigured)
virtual bool	ridIsPreconfigured () const
virtual void	setRidFilePath (const MAKRti::DtFilename &ridPath)
virtual const MAKRti::DtFilename &	ridFilePath () const
virtual void	setRidLisp (const MAKRti::DtString &lisp)
virtual const MAKRti::DtString &	ridLisp () const
virtual bool	isValid () const
	Returns true if this configuration info passes a basic validity check. More...
virtual MAKRti::DtString	constructConfigName () const
	Constructs the default configuration name using the stored parameters. More...
virtual MAKRti::DtString	constructConfigDescription () const
	Constructs the configuration description text using the stored parameters. More...

Protected Attributes
MAKRti::DtFilename	myRidFilePath
	The path to the RID configuration on disk (if RID is a user configuration). More...
MAKRti::DtString	myRidLisp
	Stored RID configuration (as lisp expressions). More...
MAKRti::DtString	myRidConfigurationName
	The name of the chosen RID configuration. More...
bool	myRidIsPreconfigured
	Whether the chosen RID configuration is preconfigured or user configured. More...
bool	myFullyCompliant
	Whether this connection specifies forceFullCompliance. More...

Detailed Description

Stores the information on an RTI configuration known by the Assistant.

Constructor & Destructor Documentation

DtRtiConnectionConfigurationInfo::DtRtiConnectionConfigurationInfo

(

)

Constructor.

DtRtiConnectionConfigurationInfo::DtRtiConnectionConfigurationInfo

(

bool

forceFullCompliance

)

Constructor.

virtual DtRtiConnectionConfigurationInfo::~DtRtiConnectionConfigurationInfo ( )

virtual

Destructor.

Member Function Documentation

virtual MAKRti::DtString DtRtiConnectionConfigurationInfo::constructConfigDescription ( ) const

virtual

Constructs the configuration description text using the stored parameters.

virtual MAKRti::DtString DtRtiConnectionConfigurationInfo::constructConfigName ( ) const

virtual

Constructs the default configuration name using the stored parameters.

virtual MAKRti::DtString DtRtiConnectionConfigurationInfo::defaultName ( ) const

virtual

Returns the default name of the configuration.

virtual MAKRti::DtString DtRtiConnectionConfigurationInfo::description ( ) const

virtual

Returns a text description of this configuration.

virtual bool DtRtiConnectionConfigurationInfo::forceFullCompliance ( ) const

virtual

Gets whether this is a fully compliant configuration.

virtual bool DtRtiConnectionConfigurationInfo::isValid ( ) const

virtual

Returns true if this configuration info passes a basic validity check.

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

virtual

Not equals operator.

See note in operator< comments for parameters which are used in comparison.

virtual bool DtRtiConnectionConfigurationInfo::operator< ( const DtRtiConnectionConfigurationInfo &  other ) const

virtual

Less than operator.

Comparisons are based on the following parameters in the order listed: 1) RID Configuration Name 2) RID Config Is Preconfigured Flag. 3) ForceFullCompliance Flag.

virtual DtRtiConnectionConfigurationInfo& DtRtiConnectionConfigurationInfo::operator= ( const DtRtiConnectionConfigurationInfo &  other )

virtual

Assignment operator.

If the connections have equivalent hosts and the host name is already set, it will not be overwritten.

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

virtual

Equals operator.

See note in operator< comments for parameters which are used in comparison.

virtual const MAKRti::DtString& DtRtiConnectionConfigurationInfo::ridConfigurationName ( ) const

virtual

virtual const MAKRti::DtFilename& DtRtiConnectionConfigurationInfo::ridFilePath ( ) const

virtual

virtual bool DtRtiConnectionConfigurationInfo::ridIsPreconfigured ( ) const

virtual

virtual const MAKRti::DtString& DtRtiConnectionConfigurationInfo::ridLisp ( ) const

virtual

virtual void DtRtiConnectionConfigurationInfo::setForceFullCompliance ( bool  compliance )

virtual

Sets whether this is a fully compliant configuration.

virtual void DtRtiConnectionConfigurationInfo::setRidConfigurationName ( const MAKRti::DtString &  name )

virtual

virtual void DtRtiConnectionConfigurationInfo::setRidFilePath ( const MAKRti::DtFilename &  ridPath )

virtual

virtual void DtRtiConnectionConfigurationInfo::setRidIsPreconfigured ( bool  isPreconfigured )

virtual

virtual void DtRtiConnectionConfigurationInfo::setRidLisp ( const MAKRti::DtString &  lisp )

virtual

Member Data Documentation

bool DtRtiConnectionConfigurationInfo::myFullyCompliant

protected

Whether this connection specifies forceFullCompliance.

MAKRti::DtString DtRtiConnectionConfigurationInfo::myRidConfigurationName

protected

The name of the chosen RID configuration.

MAKRti::DtFilename DtRtiConnectionConfigurationInfo::myRidFilePath

protected

The path to the RID configuration on disk (if RID is a user configuration).

Metadata for stored configuration (not saved with configuration or used to check equality).

bool DtRtiConnectionConfigurationInfo::myRidIsPreconfigured

protected

Whether the chosen RID configuration is preconfigured or user configured.

MAKRti::DtString DtRtiConnectionConfigurationInfo::myRidLisp

protected

Stored RID configuration (as lisp expressions).

Metadata for stored configuration (not saved with configuration or used to check equality).

---

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

• assistantConnectionConfigurationInfo.h