adtf_display_toolbox_base.h

Go to the documentation of this file.

#pragma once
 
#include "runtimeconfig.h"
 
#include <adtfbase/configuration_intf.h>
#include <adtfbase/configuration.h>
 
namespace adtf
{
namespace disptb
{

static constexpr char property_separator[] = ".";

inline std::string BuildPropertyName(std::string const& prefix, std::string const& prop_name)
{
    return (prefix + std::string(property_separator) + prop_name);
}

template<typename T>
void AttachPropertyEntry(const tChar* prop_name_prefix,
                         const tChar* prop_name,
                         T const& prop_val,
                         adtf::base::ant::IConfiguration& configuration)
{
    std::string full_prop_name = BuildPropertyName(prop_name_prefix, prop_name);
    adtf::base::set_property<T>(configuration, full_prop_name.c_str(), prop_val);
}

template<typename T>
T GetPropertyValue(std::string const& prop_name_prefix,
                   std::string const& prop_name,
                   adtf::base::ant::IConfiguration const& configuration)
{
    std::string full_prop_name = BuildPropertyName(prop_name_prefix, prop_name);
    return adtf::base::get_property<T>(configuration, full_prop_name.c_str());
}

inline bool HasProperty(std::string const& prop_name_prefix,
                        std::string const& prop_name,
                        adtf::base::ant::IConfiguration const& configuration)
{
    adtf::ucom::object_ptr<const adtf::base::ant::IProperties> pProperties;
    configuration.GetProperties(pProperties);
 
    std::string full_prop_name = BuildPropertyName(prop_name_prefix, prop_name);
    return pProperties->Exists(full_prop_name.c_str());
}

template<typename ValueType>
ValueType RestorePropertyValue(std::string const& prefix,
                               std::string const& prop_name,
                               adtf::base::ant::IConfiguration const& configuration)
{
    if (!HasProperty(prefix, prop_name, configuration))
    {
        std::string info = "Could not find property '";
        info.append(adtf::disptb::BuildPropertyName(prefix, prop_name));
        info.append("' for restoring its value.\n");
        LOG_WARNING(info.c_str());
    }
 
    // call GetPropertyValue always, it will deliver a default value in case property does not exist
    return GetPropertyValue<ValueType>(prefix, prop_name, configuration);
}
 
} // namespace disptb
 
} // namespace adtf