ModuleParam.templateDetails.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 <framework/core/PyObjConvUtils.h>
#include <boost/python/object.hpp>
#include <string>
 
namespace Belle2 {
  template <class T>
  std::string ModuleParam<T>::TypeInfo()
  {
    return PyObjConvUtils::Type<T>::name();
  }
 
  template <class T>
  ModuleParam<T>::ModuleParam(T& paramVariable, const std::string& description, bool force):
    ModuleParamBase(TypeInfo(), description, force), m_paramVariable(paramVariable) {};
 
  template <class T>
  ModuleParam<T>::~ModuleParam() = default;
 
  template <class T>
  void ModuleParam<T>::setValue(const T& value)
  {
    m_paramVariable = value;
    m_setInSteering = true;
  }
 
  template <class T>
  void ModuleParam<T>::setDefaultValue(const T& defaultValue)
  {
    m_defaultValue = defaultValue;
    m_paramVariable = defaultValue;
    m_setInSteering = false;
  }
 
  template <class T>
  T& ModuleParam<T>::getValue()
  {
    return m_paramVariable;
  }
 
  template <class T>
  T& ModuleParam<T>::getDefaultValue()
  {
    return m_defaultValue;
  }
 
  template <class T>
  void ModuleParam<T>::setValueFromPythonObject(const boost::python::object& pyObject)
  {
    // For T = std::string the boost::python::extract inside convertPythonObject
    // triggers a false-positive -Wmaybe-uninitialized in GCC; silence it here.
#if defined(__GNUC__) && !defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
#endif
    setValue(PyObjConvUtils::convertPythonObject(pyObject, getDefaultValue()));
#if defined(__GNUC__) && !defined(__clang__)
#pragma GCC diagnostic pop
#endif
  }
 
  template <class T>
  void ModuleParam<T>::setValueToPythonObject(boost::python::object& pyObject,
                                              bool defaultValues) const
  {
    pyObject =
      PyObjConvUtils::convertToPythonObject((defaultValues) ? m_defaultValue : m_paramVariable);
  }
 
  template <class T>
  void ModuleParam<T>::setValueFromParam(const ModuleParamBase& param)
  {
    const ModuleParam<T>* p = dynamic_cast<const ModuleParam<T>*>(&param);
    if (p) {
      m_defaultValue = p->m_defaultValue;
      m_paramVariable = p->m_paramVariable;
      m_setInSteering = p->m_setInSteering;
    }
  }
 
  template <class T>
  void ModuleParam<T>::resetValue()
  {
    m_paramVariable = m_defaultValue;
    m_setInSteering = false;
  }

} // end of Belle2 namespace