setupBase.hpp

Go to the documentation of this file.

 
#ifndef CCF_COMMON_SETUPBASE_HPP_H_
#define CCF_COMMON_SETUPBASE_HPP_H_
 
#include <ctd/file/Yaml.hpp>
 
#include <ccf/common/base.hpp>
 
namespace ccf::common {
 
  // TODO: Rename to ccf::common:Setup
 
  class SetupBase: public Base {
  public:
 
    static SetupBase* s_instance;
 
    // TODO: Return reference.
    static SetupBase& Instance();
 
    ~SetupBase();
 
    ctd::param::ParameterSet& GetStagingSetup();
 
    ctd::param::ParameterSet& GetSetup();
 
    void GetPar(const std::string& name,
                ctd::param::Parameter& par) const;
 
    // of the provided parameter object.
    bool HasPar(const std::string& name,
                ctd::param::Parameter& par) const;
 
    template <class TYPE>
      bool HasPar(const std::string& name,
                  TYPE& value) const {
        CCFTRACE;
        if (m_staging_setup.HasPar(name, value)) {
          return true;
        } else if (m_setup.HasPar(name, value)) {
          return true;
        } else {
          return false;
        }
      }
 
    template <class TYPE>
      bool HasStagingPar(const std::string& name,
                         TYPE& value) const {
        CCFTRACE;
        if (m_staging_setup.HasPar(name, value)) {
          return true;
        } else {
          return false;
        }
      }
 
    bool HasStagingPar(const std::string& name,
                       ctd::param::Parameter& par) const;
 
    template <class TYPE>
      TYPE GetValue(const std::string& name) const {
        CCFTRACE;
        TYPE tmp_value;
        if (m_staging_setup.HasPar(name, tmp_value)) {
          return tmp_value;
        } else if (m_setup.HasPar(name, tmp_value)) {
          return tmp_value;
        } else {
          CCFTHROW("Setup parameter requested not defined: " + name);
        }
    }
 
    void Load(const std::string& filename);
 
    void AcceptSetup();
 
  protected:
 
  private:
    SetupBase();
 
    // The New Setup object contains the parameters received for a new Setup Command, 
    // being handled.
    ctd::file::Yaml m_staging_setup;
 
    // The Setup object contains the current setup, accepted and installed (in use).
    ctd::file::Yaml m_setup;
  };
 
  inline SetupBase& GetSetup() {
    return SetupBase::Instance();
  }
 
}
 
#endif // CCF_COMMON_SETUPBASE_HPP_H_