VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends
DtConnectionSettings Class Reference

Base class for all Launcher settings objects.

Inheritance diagram for DtConnectionSettings:
Inheritance graph
[legend]

Public Member Functions

 DtConnectionSettings ()
 
 DtConnectionSettings (std::string name)
 
 DtConnectionSettings (std::string name, DtProtocolTypes protocol)
 
 DtConnectionSettings (const DtConnectionSettings &orig)
 
virtual ~DtConnectionSettings () override
 
virtual bool operator== (const DtConnectionSettings &orig) const
 
virtual bool operator!= (const DtConnectionSettings &orig) const
 
virtual bool setFrom (const DtConnectionSettings *other)
 
virtual bool setFrom (const DtConnectionFileRecord &rec)
 
virtual bool connectionWillBeValid () const
 
virtual bool connectionWillBeValid (const QString deviceAddress) const
 
virtual bool setToFileRecord (DtConnectionFileRecord *rec)
 
virtual void setName (std::string name)
 
virtual std::string name () const override
 
virtual void setDescription (const std::string &)
 
virtual std::string description () const
 
virtual DtProtocolTypes protocolType () const
 
virtual void setProtocolType (DtProtocolTypes type)
 
virtual bool autoConnection () const
 
virtual void setAutoConnection (bool conn)
 
virtual bool selectAtStart () const
 
virtual void setSelectAtStart (bool)
 
virtual ConnectionArgValuesargValues ()
 
virtual void updateStringArgValue (unsigned int type, QString qstringValue)
 
virtual void updateBoolArgValue (unsigned int type, bool boolValue)
 
virtual void updateIntArgValue (unsigned int type, int intValue, bool negativeOneOk=false)
 
virtual bool getArgValue (unsigned int argType, QString &argValue) const
 
virtual void removeArgValueEntry (unsigned int type)
 
virtual bool findArgDescriptor (unsigned int type, ArgFlagDescriptorPair &mappingStorage) const
 
virtual QStringList flagsFromLinkConfigFile () const
 
virtual QStringList frontEndFlags () const
 
virtual QStringList backEndFlags () const
 
virtual std::string summary () const
 
void setAutoConnect (bool b)
 
bool autoConnect () const
 
- Public Member Functions inherited from DtSettingsObject
 DtSettingsObject ()
 
 DtSettingsObject (std::string name)
 
 DtSettingsObject (const DtSettingsObject &orig)
 
virtual void operator= (const DtSettingsObject &orig)
 
virtual bool operator== (const DtSettingsObject &orig) const
 
virtual bool operator!= (const DtSettingsObject &orig) const
 
virtual DtSettingsObjectclone () const =0
 
virtual ~DtSettingsObject ()
 
virtual bool setFrom (const DtSettingsObject *other)
 

Static Public Member Functions

static DtConnectionSettingscreateFromDriverRecord (DtConnectionFileRecord &driverRecord, QString connName="")
 
static DtConnectionSettingscreateFromProtocol (DtProtocolTypes protocol, QString connName="")
 

Protected Member Functions

virtual void initialize ()
 

Protected Attributes

ArgIndexDescriptionMap myArgDescriptors
 
bool myAmAutoConnection
 
DtProtocolTypes myProtocolType
 
std::string mySettingsType
 
ConnectionArgValues myArgValues
 
bool mySelectAtStart = false
 
std::string myDescription
 
- Protected Attributes inherited from DtSettingsObject
std::string myName
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Friends

class boost::serialization::access
 

Constructor & Destructor Documentation

DtConnectionSettings::DtConnectionSettings ( )

Default constructor, required for deserialization.

DtConnectionSettings::DtConnectionSettings ( std::string  name)

Constructor.

DtConnectionSettings::DtConnectionSettings ( std::string  name,
DtProtocolTypes  protocol 
)

Constructor.

DtConnectionSettings::DtConnectionSettings ( const DtConnectionSettings orig)

Copy constructor.

virtual DtConnectionSettings::~DtConnectionSettings ( )
overridevirtual

Member Function Documentation

virtual bool DtConnectionSettings::operator== ( const DtConnectionSettings orig) const
virtual

Equality operator.

Reimplemented in DtConnectionDISSettings, DtConnectionEVOSettings, and DtConnectionHLA4Settings.

virtual bool DtConnectionSettings::operator!= ( const DtConnectionSettings orig) const
virtual

Inequality operator.

Reimplemented in DtConnectionDISSettings, DtConnectionEVOSettings, and DtConnectionHLA4Settings.

virtual bool DtConnectionSettings::setFrom ( const DtConnectionSettings other)
virtual

Reset this object based on another, used by DtSettingsManager::setSetting.

Reimplemented in DtConnectionDISSettings, DtConnectionEVOSettings, and DtConnectionHLA4Settings.

virtual bool DtConnectionSettings::setFrom ( const DtConnectionFileRecord rec)
virtual
virtual bool DtConnectionSettings::connectionWillBeValid ( ) const
virtual

Returns true if the connection will be valid. Checks the connection settings.

Reimplemented in DtConnectionEVOSettings, and DtConnectionHLA4Settings.

virtual bool DtConnectionSettings::connectionWillBeValid ( const QString  deviceAddress) const
virtual
virtual bool DtConnectionSettings::setToFileRecord ( DtConnectionFileRecord rec)
virtual
virtual void DtConnectionSettings::setName ( std::string  name)
virtual
virtual std::string DtConnectionSettings::name ( ) const
overridevirtual

Reimplemented from DtSettingsObject.

virtual void DtConnectionSettings::setDescription ( const std::string &  )
virtual
virtual std::string DtConnectionSettings::description ( ) const
inlinevirtual
virtual DtProtocolTypes DtConnectionSettings::protocolType ( ) const
virtual

What protocol is this connection.

virtual void DtConnectionSettings::setProtocolType ( DtProtocolTypes  type)
virtual
virtual bool DtConnectionSettings::autoConnection ( ) const
virtual
virtual void DtConnectionSettings::setAutoConnection ( bool  conn)
virtual
virtual bool DtConnectionSettings::selectAtStart ( ) const
virtual
virtual void DtConnectionSettings::setSelectAtStart ( bool  )
virtual
virtual ConnectionArgValues* DtConnectionSettings::argValues ( )
virtual

accessor to myArgsMap

virtual void DtConnectionSettings::updateStringArgValue ( unsigned int  type,
QString  qstringValue 
)
virtual
virtual void DtConnectionSettings::updateBoolArgValue ( unsigned int  type,
bool  boolValue 
)
virtual
virtual void DtConnectionSettings::updateIntArgValue ( unsigned int  type,
int  intValue,
bool  negativeOneOk = false 
)
virtual
virtual bool DtConnectionSettings::getArgValue ( unsigned int  argType,
QString &  argValue 
) const
virtual
virtual void DtConnectionSettings::removeArgValueEntry ( unsigned int  type)
virtual

Removes setting from map so it is no longer on the command line.

virtual bool DtConnectionSettings::findArgDescriptor ( unsigned int  type,
ArgFlagDescriptorPair mappingStorage 
) const
virtual
virtual QStringList DtConnectionSettings::flagsFromLinkConfigFile ( ) const
virtual
virtual QStringList DtConnectionSettings::frontEndFlags ( ) const
virtual
virtual QStringList DtConnectionSettings::backEndFlags ( ) const
virtual
virtual std::string DtConnectionSettings::summary ( ) const
virtual
static DtConnectionSettings* DtConnectionSettings::createFromDriverRecord ( DtConnectionFileRecord driverRecord,
QString  connName = "" 
)
static
static DtConnectionSettings* DtConnectionSettings::createFromProtocol ( DtProtocolTypes  protocol,
QString  connName = "" 
)
static
void DtConnectionSettings::setAutoConnect ( bool  b)
inline
bool DtConnectionSettings::autoConnect ( ) const
inline
virtual void DtConnectionSettings::initialize ( )
protectedvirtual

Stores the available command line args for this connection. Override to add new args.

Reimplemented in DtConnectionDISSettings, DtConnectionEVOSettings, and DtConnectionHLA4Settings.

template<class Archive >
void DtConnectionSettings::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprivate

Serialization support. Derived classes must call BOOST_SERIALIZATION_BASE_OBJECT_NVP(DtSettingsObject) in their implementation of serialize.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Member Data Documentation

ArgIndexDescriptionMap DtConnectionSettings::myArgDescriptors
protected
bool DtConnectionSettings::myAmAutoConnection
protected
DtProtocolTypes DtConnectionSettings::myProtocolType
protected
std::string DtConnectionSettings::mySettingsType
protected
ConnectionArgValues DtConnectionSettings::myArgValues
protected

Holds all the cmd args that have been set for this connection.

bool DtConnectionSettings::mySelectAtStart = false
protected
std::string DtConnectionSettings::myDescription
protected

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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)