ADTF_DISPLAY_TOOLBOX  3.8.0 (ADTF 3.14.3)
cRuntimeConfigFile

Class is a adtf::base::configuration that allows the storing and loading of all contained properties to/from a xml file. More...

Inheritance diagram for cRuntimeConfigFile:
[legend]

Public Member Functions

 cRuntimeConfigFile (const adtf_util::cFilename &strConfigFile)
 Constructor. More...
 
tResult Load ()
 Loads all properties from the configured xml file and stores it to this instance. More...
 
tResult Save ()
 Saves all properties of this instance to the configured xml file. More...
 
tResult ClearAllProperties ()
 Clears all properties currently stored in cRuntimeConfigFile. More...
 
tVoid SetConfigFile (const adtf_util::cFilename &strFilename)
 Setter for xml config file to load and store runtime configuration. More...
 
adtf_util::cFilename GetConfigFile ()
 Setter for xml config file to load and store runtime configuration. More...
 

Protected Attributes

adtf_util::cFilename m_strConfigFile
 path to the xml file
 

Private Member Functions

tResult StoreProperty (adtf_util::cString strPrefix, adtf_util::cDOMElement *pConfig)
 Stores all properties of this instance in DOM pConfig. More...
 

Detailed Description

Class is a adtf::base::configuration that allows the storing and loading of all contained properties to/from a xml file.

Definition at line 15 of file runtimeconfig.h.

Constructor & Destructor Documentation

◆ cRuntimeConfigFile()

cRuntimeConfigFile ( const adtf_util::cFilename &  strConfigFile)

Constructor.

Parameters
[in]strConfigFilexml file to load and store runtime configuration

Member Function Documentation

◆ ClearAllProperties()

tResult ClearAllProperties ( )

Clears all properties currently stored in cRuntimeConfigFile.

Returns
Standard result.

◆ GetConfigFile()

adtf_util::cFilename GetConfigFile ( )

Setter for xml config file to load and store runtime configuration.

Returns
Path to config file

◆ Load()

tResult Load ( )

Loads all properties from the configured xml file and stores it to this instance.

Returns
Standard result.

◆ Save()

tResult Save ( )

Saves all properties of this instance to the configured xml file.

Returns
Standard result.

◆ SetConfigFile()

tVoid SetConfigFile ( const adtf_util::cFilename &  strFilename)

Setter for xml config file to load and store runtime configuration.

Returns
Standard result.
Parameters
[in]strFilenamevalue to set

◆ StoreProperty()

tResult StoreProperty ( adtf_util::cString  strPrefix,
adtf_util::cDOMElement *  pConfig 
)
private

Stores all properties of this instance in DOM pConfig.

Parameters
[in]strPrefixPrefix under which the properties are stored in DOM.
[in]pConfigDOM to store data to.
Returns
Standard result.