MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Private Member Functions

Stores the Assistant configuration information and handles saving and loading this information from an XML file. More...

+ Inheritance diagram for DtAssistantConfig:
+ Collaboration diagram for DtAssistantConfig:

Public Member Functions

 DtAssistantConfig (const MAKRti::DtFilename &xmlFile)
 Constructor. More...
 
virtual ~DtAssistantConfig ()
 Destructor. More...
 
- Public Member Functions inherited from DtBaseConfig
 DtBaseConfig (const MAKRti::DtFilename &xmlFile)
 Constructor. More...
 
virtual ~DtBaseConfig ()
 Destructor. More...
 
virtual void writeToFile ()
 Writes the configuration to the default XML file specified at creation. More...
 
virtual void writeToFile (const MAKRti::DtFilename &xmlFile)
 Writes the configuration to the specified XML file. More...
 
virtual bool getFileVersion (MAKRti::DtString &version) const
 Returns the RTI version of the file that was read. More...
 
virtual bool isFileVersionOld () const
 is the file read version different than the current version More...
 
virtual void needsUpdate ()
 sets the update flag More...
 
virtual std::ostream & print (std::ostream &ostr) const
 Prints the configuration to the given output stream. More...
 

Protected Member Functions

virtual void setDefaultConfig ()
 Sets the default configuration. More...
 
- Protected Member Functions inherited from DtBaseConfig
MAKRti::DtEnvValueSP setParam (const MAKRti::DtString &name, const MAKRti::DtString &val, const MAKRti::DtString &comment=MAKRti::DtString::nullString())
 Sets (or adds) the given parameter to the configuration. More...
 
MAKRti::DtEnvValueSP getParam (const MAKRti::DtString &name)
 Gets the parameter with the given name. More...
 

Private Member Functions

 DtAssistantConfig (const DtAssistantConfig &)
 Copy and assignment not allowed. More...
 
DtAssistantConfigoperator= (const DtAssistantConfig &)
 

Additional Inherited Members

- Protected Attributes inherited from DtBaseConfig
MAKRti::DtEnvironment myEnvironment
 The Base configuration environment. More...
 
std::auto_ptr
< MAKRti::DtEnvXMLWriter > 
myXmlWriter
 Document writer - used to convert the document to XML in memory or file myXmlWriter is persistent so that the XML memory buffer does not re-allocate as often. More...
 
MAKRti::DtFilename myXmlFile
 The name of the default XML file to read from and write to. More...
 
bool myUpdatedSinceWrite
 Flag indicating if the environment has changed since the last time it was written to the default file. More...
 
MAKRti::DtString myReadFileVersion
 The version of the file that was read. More...
 
bool myFileWasRead
 Indicates whether a cache file was found and read. More...
 

Detailed Description

Stores the Assistant configuration information and handles saving and loading this information from an XML file.

Constructor & Destructor Documentation

DtAssistantConfig::DtAssistantConfig ( const MAKRti::DtFilename &  xmlFile)

Constructor.

Creates an Assistant configuration from the given XML file. If the file cannot be found, a default configuration is created. In this case the file name will be saved as the default file if the configuration needs to be written later.

virtual DtAssistantConfig::~DtAssistantConfig ( )
virtual

Destructor.

DtAssistantConfig::DtAssistantConfig ( const DtAssistantConfig )
private

Copy and assignment not allowed.

Member Function Documentation

DtAssistantConfig& DtAssistantConfig::operator= ( const DtAssistantConfig )
private
virtual void DtAssistantConfig::setDefaultConfig ( )
inlineprotectedvirtual

Sets the default configuration.

Implements DtBaseConfig.


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

Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)