ADTF_DISPLAY_TOOLBOX  3.8.0 (ADTF 3.14.3)
cRuntimeConfiguration< T >abstract

Template class enables the loading and storing of runtime configuration data. More...

Inheritance diagram for cRuntimeConfiguration< T >:
[legend]

Public Member Functions

tResult SaveRuntimeConfigFile ()
 Saves all properties to the file configured with adtf-property runtime_config_file_path. More...
 
tResult LoadRuntimeConfigFile ()
 Loads all properties from the file configured with adtf-property runtime_config_file_path. More...
 

Protected Member Functions

virtual tResult SaveConfiguration (adtf::base::IConfiguration *pRuntimeConfig)=0
 Callback to be implemented by user of runtime_configuration. More...
 
virtual tResult LoadConfiguration (adtf::base::IConfiguration *pRuntimeConfig)=0
 Callback to be implemented by user of runtime_configuration. More...
 

Protected Attributes

adtf::base::property_variable< adtf_util::cFilename > m_strConfigFile
 CE property_variable storing path of runtime configuration file.
 
cRuntimeConfigFile m_oRuntimeConfig
 actual runtime configuration
 

Private Member Functions

adtf_util::cString GetConfigFile ()
 Getter for path of configuration file. More...
 

Detailed Description

template<typename T>
class cRuntimeConfiguration< T >

Template class enables the loading and storing of runtime configuration data.

Typlically a service or filter would inherit from runtime_configuration<T>. The filter/service will then inherit a property 'runtime_config_file_path'. This property can be used to configure the path of the runtime configuration file by the CE.

A call to SaveRuntimeConfigFile() will store all properties to the runtime configuration file A call to LoadRuntimeConfigFile() will load all properties from the runtime configuration file

Template Parameters
Tenables a runtime_configuration to inherit from some other class

Definition at line 123 of file runtimeconfig.h.

Member Function Documentation

◆ GetConfigFile()

adtf_util::cString GetConfigFile
private

Getter for path of configuration file.

Returns
Path of configuration file

Definition at line 203 of file runtimeconfig.h.

◆ LoadConfiguration()

virtual tResult LoadConfiguration ( adtf::base::IConfiguration *  pRuntimeConfig)
protectedpure virtual

Callback to be implemented by user of runtime_configuration.

Implementation has to get all properties from pRuntimeConfig (contains all loaded properties from runtime configuration file)

Parameters
[in]pRuntimeConfigIConfiguration to read properties from
Returns
Standard result.

Implements IRuntimeConfigurationLoadSave.

◆ LoadRuntimeConfigFile()

tResult LoadRuntimeConfigFile

Loads all properties from the file configured with adtf-property runtime_config_file_path.

Returns
Standard result.

Definition at line 231 of file runtimeconfig.h.

◆ SaveConfiguration()

virtual tResult SaveConfiguration ( adtf::base::IConfiguration *  pRuntimeConfig)
protectedpure virtual

Callback to be implemented by user of runtime_configuration.

Implementation has to add all properties to be written to runtime configuration file to pRuntimeConfig

Parameters
[out]pRuntimeConfigIConfiguration to store properties to
Returns
Standard result.

Implements IRuntimeConfigurationLoadSave.

◆ SaveRuntimeConfigFile()

tResult SaveRuntimeConfigFile

Saves all properties to the file configured with adtf-property runtime_config_file_path.

Returns
Standard result.

Definition at line 209 of file runtimeconfig.h.