ModuleParam.h

/**************************************************************************
 * BASF2 (Belle Analysis Framework 2)                                     *
 * Copyright(C) 2010 - Belle II Collaboration                             *
 *                                                                        *
 * Author: The Belle II Collaboration                                     *
 * Contributors: Andreas Moll                                             *
 *                                                                        *
 * This software is provided "as is" without any warranty.                *
 **************************************************************************/
#pragma once
 
#include <framework/core/ModuleParamBase.h>
 
#include <string>
 
namespace boost {
  namespace python {
    namespace api {
      class object;
    }
    using api::object;
  }
}
 
namespace Belle2 {
  template <class T>
  class ModuleParam : public ModuleParamBase {
 
  public:
    static std::string TypeInfo();
 
    explicit ModuleParam(T& paramVariable, const std::string& description = "", bool force = false);
 
    virtual ~ModuleParam();
 
    void setValue(const T& value);
 
    void setDefaultValue(const T& defaultValue);
 
    T& getValue();
 
    T& getDefaultValue();
 
    virtual void setValueFromPythonObject(const boost::python::object& pyObject) final;
 
    virtual void
    setValueToPythonObject(boost::python::object& pyObject, bool defaultValues = false) const final;
 
    virtual void setValueFromParam(const ModuleParamBase& param) final;
 
    void resetValue();
 
  private:
    T m_defaultValue{};
 
    T& m_paramVariable;
  };
} // end of Belle2 namespace