MAK RTIspy API Documentation for HLA 1516
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtRtiConnectionConfigurationInfo Class Reference

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

+ Collaboration diagram for DtRtiConnectionConfigurationInfo:

Public Member Functions

 DtRtiConnectionConfigurationInfo ()
 Constructor.
 DtRtiConnectionConfigurationInfo (bool forceFullCompliance)
 Constructor.
virtual ~DtRtiConnectionConfigurationInfo ()
 Destructor.
virtual bool operator< (const DtRtiConnectionConfigurationInfo &other) const
 Less than operator.
virtual bool operator== (const DtRtiConnectionConfigurationInfo &other) const
 Equals operator.
virtual bool operator!= (const DtRtiConnectionConfigurationInfo &other) const
 Not equals operator.
virtual
DtRtiConnectionConfigurationInfo
operator= (const DtRtiConnectionConfigurationInfo &other)
 Assignment operator.
virtual MAKRti::DtString defaultName () const
 Returns the default name of the configuration.
virtual MAKRti::DtString description () const
 Returns a text description of this configuration.
virtual void setForceFullCompliance (bool compliance)
 Sets whether this is a fully compliant configuration.
virtual bool forceFullCompliance () const
 Gets whether this is a fully compliant configuration.
virtual bool isValid () const
 Returns true if this configuration info passes a basic validity check.

Static Public Member Functions

static MAKRti::DtString constructConfigName (bool forceFullCompliance)
 Constructs the default configuration name using the given parameters.
static MAKRti::DtString constructConfigDescription (bool forceFullCompliance)
 Constructs the configuration description text using the given parameters.

Protected Attributes

bool myFullyCompliant
 Whether this connection specifies forceFullCompliance.

Detailed Description

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

Constructor & Destructor Documentation

DtRtiConnectionConfigurationInfo::DtRtiConnectionConfigurationInfo ( )

Constructor.

DtRtiConnectionConfigurationInfo::DtRtiConnectionConfigurationInfo ( bool  forceFullCompliance)

Constructor.

DtRtiConnectionConfigurationInfo::~DtRtiConnectionConfigurationInfo ( )
virtual

Destructor.

Member Function Documentation

MAKRti::DtString DtRtiConnectionConfigurationInfo::constructConfigDescription ( bool  forceFullCompliance)
static

Constructs the configuration description text using the given parameters.

Referenced by description().

MAKRti::DtString DtRtiConnectionConfigurationInfo::constructConfigName ( bool  forceFullCompliance)
static

Constructs the default configuration name using the given parameters.

Referenced by defaultName().

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

Returns the default name of the configuration.

References constructConfigName(), and myFullyCompliant.

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

Returns a text description of this configuration.

References constructConfigDescription(), and myFullyCompliant.

bool DtRtiConnectionConfigurationInfo::forceFullCompliance ( ) const
virtual
bool DtRtiConnectionConfigurationInfo::isValid ( ) const
virtual

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

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

Not equals operator.

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

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

Less than operator.

Comparisons are based on the following parameters in the order listed: 1) ForceFullCompliance.

References forceFullCompliance(), and myFullyCompliant.

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.

References forceFullCompliance(), and setForceFullCompliance().

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

Equals operator.

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

References forceFullCompliance(), and myFullyCompliant.

void DtRtiConnectionConfigurationInfo::setForceFullCompliance ( bool  compliance)
virtual

Member Data Documentation

bool DtRtiConnectionConfigurationInfo::myFullyCompliant
protected

Whether this connection specifies forceFullCompliance.

Referenced by defaultName(), description(), forceFullCompliance(), operator<(), operator==(), and setForceFullCompliance().


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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)