runtimeconfig.h

Go to the documentation of this file.

 
#pragma once
 
#include <adtf_platform_inc.h>
#include <adtf_base.h>
 
class cRuntimeConfigFile : public adtf::ucom::object<adtf::base::configuration<>>
{
protected:
    adtf_util::cFilename        m_strConfigFile;
 
public:
    cRuntimeConfigFile(const adtf_util::cFilename &strConfigFile);
 
 
 
 
    virtual ~cRuntimeConfigFile();
 
    tResult Load();
 
    tResult Save();
 
    tResult ClearAllProperties();
 
    tVoid SetConfigFile(const adtf_util::cFilename &strFilename);
 
    adtf_util::cFilename GetConfigFile();
 
private:
    tResult StoreProperty(adtf_util::cString strPrefix, adtf_util::cDOMElement* pConfig);
};
 
 
 
 
class IRuntimeConfigurationLoadSave
{
public:
    virtual tResult SaveConfiguration(adtf::base::IConfiguration* pRuntimeConfig) = 0;
 
    virtual tResult LoadConfiguration(adtf::base::IConfiguration* pRuntimeConfig) = 0;
};
 
 
template <typename T>
class cRuntimeConfiguration :
    public T,
    public IRuntimeConfigurationLoadSave
{
 
protected:
    adtf::base::property_variable<adtf_util::cFilename>        m_strConfigFile;
    cRuntimeConfigFile                                         m_oRuntimeConfig;
 
public:
    cRuntimeConfiguration();
    ~cRuntimeConfiguration();
 
    tResult SaveRuntimeConfigFile();
    tResult LoadRuntimeConfigFile();
 
protected:
    virtual tResult SaveConfiguration(adtf::base::IConfiguration* pRuntimeConfig) = 0;
 
    virtual tResult LoadConfiguration(adtf::base::IConfiguration* pRuntimeConfig) = 0;
 
private:
    adtf_util::cString GetConfigFile();
};
 
 
 
 
 
template <typename T>
cRuntimeConfiguration<T>::cRuntimeConfiguration() :
    m_strConfigFile("$(ADTF_GRAPH_DIR)/$(THIS_OBJECT_FULL_NAME)"),
    // config file cant be set at creation because property will be resolved later
    m_oRuntimeConfig("")
{
    m_strConfigFile.SetDescription("Path to configuration file for runtime settings.");
    T::RegisterPropertyVariable("runtime_config_file_path", m_strConfigFile);
}
 
template <typename T>
cRuntimeConfiguration<T>::~cRuntimeConfiguration()
{
 
}
 
template <typename T>
adtf_util::cString cRuntimeConfiguration<T>::GetConfigFile()
{
    return static_cast<adtf_util::cFilename>(m_strConfigFile).MakeNativeSlashes();
}
 
template <typename T>
tResult cRuntimeConfiguration<T>::SaveRuntimeConfigFile()
{
    if (m_oRuntimeConfig.GetConfigFile().Empty)
    {
        m_oRuntimeConfig.SetConfigFile(GetConfigFile());
    }
 
    RETURN_IF_FAILED(m_oRuntimeConfig.ClearAllProperties());
 
    RETURN_IF_FAILED(this->SaveConfiguration(&m_oRuntimeConfig));
    if IS_FAILED(m_oRuntimeConfig.Save())
    {
        RETURN_AND_LOG_ERROR_STR(ERR_FAILED, "Runtime configuration could not be stored");
    }
    else
    {
        LOG_INFO("Runtime configuration was stored to file");
    }
    RETURN_NOERROR;
}
 
template <typename T>
tResult cRuntimeConfiguration<T>::LoadRuntimeConfigFile()
{
    if (!adtf_util::cFileSystem::Exists(GetConfigFile()))
    {
        RETURN_ERROR_DESC(ERR_FILE_NOT_FOUND, 
            "Runtime configuration file '%s' does not exist", static_cast<adtf_util::cString>(m_strConfigFile).GetPtr());
    }
 
    if (m_oRuntimeConfig.GetConfigFile().Empty)
    {
        m_oRuntimeConfig.SetConfigFile(GetConfigFile());
    }
 
    RETURN_IF_FAILED(m_oRuntimeConfig.Load());
 
    if IS_FAILED(this->LoadConfiguration(&m_oRuntimeConfig))
    {
        RETURN_ERROR_DESC(ERR_FAILED, "Runtime configuration could not be read");
    }
 
    RETURN_NOERROR;
}