param_utils/param_helper.hpp

Go to the documentation of this file.

#pragma once

#include <memory>
#include <string>
#include <utility>

#include <cras_cpp_common/log_utils.h>
#include <cras_cpp_common/param_utils.hpp>
#include <cras_cpp_common/param_utils/get_param_adapter.hpp>
#include <cras_cpp_common/param_utils/get_param_options.hpp>
#include <cras_cpp_common/param_utils/get_param_result.hpp>
#include <cras_cpp_common/optional.hpp>

namespace cras
{

class ParamHelper : public ::cras::HasLogger
{
public:
  explicit ParamHelper(const ::cras::LogHelperPtr& log) : ::cras::HasLogger(log) {}
  virtual ~ParamHelper() = default;

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ::cras::GetParamResult<ResultType> getParamVerbose(
    const ::cras::GetParamAdapter& param, const ::std::string& name,
    const ::cras::optional<ResultType>& defaultValue = ResultType(),
    const ::std::string& unit = "",
    const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::getParamVerbose(param, name, defaultValue, unit, options, this->log.get());
  }

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ::cras::GetParamResult<ResultType> getParamVerbose(
    const ::cras::GetParamAdapter& param, const ::std::string& name,
    const ResultType& defaultValue = ResultType(),
    const ::std::string& unit = "",
    const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::getParamVerbose(param, name, defaultValue, unit, options, this->log.get());
  }

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ResultType getParam(
    const ::cras::GetParamAdapter& param, const ::std::string& name,
    const ::cras::optional<ResultType>& defaultValue = ResultType(),
    const ::std::string& unit = "",
    const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::getParam(param, name, defaultValue, unit, options, this->log.get());
  }

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ResultType getParam(
    const ::cras::GetParamAdapter& param, const ::std::string& name,
    const ResultType& defaultValue = ResultType(),
    const ::std::string& unit = "",
    const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::getParam(param, name, defaultValue, unit, options, this->log.get());
  }

  // std::string - char interop specializations

  inline ::cras::GetParamResult<::std::string> getParamVerbose(
    const ::cras::GetParamAdapter& param, const ::std::string& name,
    const ::cras::optional<const char *>& defaultValue, const ::std::string& unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::getParamVerbose(param, name, defaultValue, unit, options, this->log.get());
  }

  inline ::cras::GetParamResult<::std::string> getParamVerbose(
    const ::cras::GetParamAdapter& param, const ::std::string &name,
    const char* defaultValue, const ::std::string &unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::getParamVerbose(param, name, defaultValue, unit, options, this->log.get());
  }

  inline ::std::string getParam(
    const ::cras::GetParamAdapter& param, const ::std::string &name,
    const ::cras::optional<const char *>& defaultValue, const ::std::string &unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::getParam(param, name, defaultValue, unit, options, this->log.get());
  }

  inline ::std::string getParam(
    const ::cras::GetParamAdapter& param, const ::std::string &name,
    const char* defaultValue, const ::std::string &unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::getParam(param, name, defaultValue, unit, options, this->log.get());
  }

  ::cras::LogHelperPtr getLogger() const
  {
    return this->log;
  }

  void setLogger(const ::cras::LogHelperPtr& logger)
  {
    this->log = logger;
  }
};

typedef ::std::shared_ptr<::cras::ParamHelper> ParamHelperPtr;

}