ModuleParamBase.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 <string>
 
namespace boost {
  namespace python {
    namespace api {
      class object;
    }
    using api::object;
  }
}
 
namespace Belle2 {
  class ModuleParamBase {
 
  public:
    ModuleParamBase(std::string  typeInfo, std::string  description, bool force);

    virtual ~ModuleParamBase();

    const std::string& getTypeInfo() const;

    const std::string& getDescription() const;

    void setDescription(const std::string& description);

    bool isSetInSteering() const;

    bool isForcedInSteering() const;

    virtual void setValueFromPythonObject(const boost::python::object& pyObject) = 0;

    virtual void
    setValueToPythonObject(boost::python::object& pyObject, bool defaultValues = false) const = 0;

    virtual void setValueFromParam(const ModuleParamBase& param) = 0;
 
  protected:
    std::string m_typeInfo;

    std::string m_description;

    bool m_forceInSteering;

    bool m_setInSteering;
  };

} // end of Belle2 namespace