ModuleParamList.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/core/ModuleParam.h>
 
#include <map>
#include <vector>
#include <string>
#include <memory>
 
namespace boost {
  namespace python {
    class list;
    namespace api {
      class object;
    }
    using api::object;
  }
}
 
namespace Belle2 {
  //------------------------------------------------------
  //             Define convenient typdefs
  //------------------------------------------------------
 
  using ModuleParamPtr = std::shared_ptr<ModuleParamBase>;
 
  class ModuleParamList {
 
  private:
    [[noreturn]] static void throwNotFoundError(const std::string& name);
 
    [[noreturn]] static void throwTypeError(const std::string& name,
                                            const std::string& expectedTypeInfo,
                                            const std::string& typeInfo);
  public:
    ModuleParamList();
 
    ~ModuleParamList();
 
    template<typename T>
    void addParameter(const std::string& name, T& paramVariable, const std::string& description, const T& defaultValue);
 
    template<typename T>
    void addParameter(const std::string& name, T& paramVariable, const std::string& description);
 
    template<typename T>
    void setParameter(const std::string& name, const T& value);
 
    void setParameters(const ModuleParamList& params);
 
    std::vector<std::string> getParameterNames() const;
 
    std::string getParameterDescription(const std::string& name) const;
 
    std::string getParameterTypeInfo(const std::string& name) const;
 
    template<typename T>
    ModuleParam<T>& getParameter(const std::string& name) const;
 
    std::vector<std::string> getUnsetForcedParams() const;
 
    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    //                   Python API
    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
    std::shared_ptr<boost::python::list> getParamInfoListPython() const;
 
    template<typename PythonObject>
    void setParamPython(const std::string& name, const PythonObject& pyObj);
 
    template<typename PythonObject>
    void getParamValuesPython(const std::string& name, PythonObject& pyOutput, bool defaultValues) const;
 
  private:
    ModuleParamPtr getParameterPtr(const std::string& name) const;
 
  private:
    std::map<std::string, ModuleParamPtr> m_paramMap;
  };
 
  // These frequent template instantiations are provided by the library and do not require including the details header
  extern template void ModuleParamList::addParameter(const std::string&, bool&, const std::string&, const bool&);
  extern template void ModuleParamList::addParameter(const std::string&, double&, const std::string&, const double&);
  extern template void ModuleParamList::addParameter(const std::string&, float&, const std::string&, const float&);
  extern template void ModuleParamList::addParameter(const std::string&, int&, const std::string&, const int&);
  extern template void ModuleParamList::addParameter(const std::string&, std::string&, const std::string&, const std::string&);
 
} //end of Belle2 namespace