ModuleParamList.cc

/**************************************************************************
 * 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.                  *
 **************************************************************************/
#include <framework/core/ModuleParamList.templateDetails.h>
 
#include <framework/core/ModuleParamInfoPython.h>
#include <framework/core/FrameworkExceptions.h>
 
#include <boost/python/object.hpp>
#include <boost/python/list.hpp>
 
#include <utility>
#include <memory>
 
using namespace Belle2;
 
BELLE2_DEFINE_EXCEPTION(ModuleParameterNotFoundError,
                        "Could not find the parameter with the "
                        "name '%1%'! The value of the parameter "
                        "could NOT be set.");
 
BELLE2_DEFINE_EXCEPTION(ModuleParameterTypeError,
                        "The type of the module parameter '%1%' "
                        "(%2%) is different from the type of the "
                        "value it should be set to (%3%)!");
 
void ModuleParamList::throwNotFoundError(const std::string& name)
{
  throw (ModuleParameterNotFoundError() << name);
}
 
void ModuleParamList::throwTypeError(const std::string& name,
                                     const std::string& expectedTypeInfo,
                                     const std::string& typeInfo)
{
  throw (ModuleParameterTypeError() << name << expectedTypeInfo << typeInfo);
}
 
ModuleParamList::ModuleParamList() = default;
 
 
ModuleParamList::~ModuleParamList()
{
  m_paramMap.clear();
}
 
 
std::vector<std::string> ModuleParamList::getUnsetForcedParams() const
{
  std::vector<std::string> missingParam;
  for (const auto& mapEntry : m_paramMap) {
    if (mapEntry.second->isForcedInSteering() && !mapEntry.second->isSetInSteering())
      missingParam.push_back(mapEntry.first);
  }
  return missingParam;
}
 
std::shared_ptr<boost::python::list> ModuleParamList::getParamInfoListPython() const
{
  std::shared_ptr<boost::python::list> returnList(new boost::python::list);
  std::map<std::string, ModuleParamPtr>::const_iterator mapIter;
 
  for (mapIter = m_paramMap.begin(); mapIter != m_paramMap.end(); ++mapIter) {
    ModuleParamInfoPython newParamInfo;
    ModuleParamPtr currParam = mapIter->second;
 
    newParamInfo.m_name = mapIter->first;
    newParamInfo.m_description = currParam->getDescription();
    newParamInfo.m_typeName = currParam->getTypeInfo();
    newParamInfo.m_setInSteering = currParam->isSetInSteering();
    newParamInfo.m_forceInSteering = currParam->isForcedInSteering();
    getParamValuesPython(mapIter->first, newParamInfo.m_defaultValues, true);
    getParamValuesPython(mapIter->first, newParamInfo.m_values, false);
 
    returnList->append(boost::python::object(newParamInfo));
  }
  return returnList;
}
 
void ModuleParamList::setParameters(const ModuleParamList& params)
{
  for (const auto& param : params.m_paramMap) {
    auto& myParam = m_paramMap.at(param.first);
    myParam->setValueFromParam(*param.second.get());
  }
}
 
 
std::vector<std::string> ModuleParamList::getParameterNames() const
{
  std::vector<std::string> names;
  names.reserve(m_paramMap.size());
  for (const auto& nameAndParam : m_paramMap) {
    names.push_back(nameAndParam.first);
  }
  return names;
}
 
std::string ModuleParamList::getParameterDescription(const std::string& name) const
{
  return getParameterPtr(name)->getDescription();
}
 
std::string ModuleParamList::getParameterTypeInfo(const std::string& name) const
{
  return getParameterPtr(name)->getTypeInfo();
}
 
 
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
//==================================================================================
//                                Private methods
//==================================================================================
 
ModuleParamPtr ModuleParamList::getParameterPtr(const std::string& name) const
{
  //Check if a parameter with the given name exists
  std::map<std::string, ModuleParamPtr>::const_iterator mapIter;
  mapIter = m_paramMap.find(name);
 
  if (mapIter != m_paramMap.end()) {
    return mapIter->second;
  } else throw (ModuleParameterNotFoundError() << name);
}
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 
//==================================================================================
//                          Explicit template instantiations
//==================================================================================
 
template void ModuleParamList::addParameter(const std::string&, bool&, const std::string&, const bool&);
template void ModuleParamList::addParameter(const std::string&, double&, const std::string&, const double&);
template void ModuleParamList::addParameter(const std::string&, float&, const std::string&, const float&);
template void ModuleParamList::addParameter(const std::string&, int&, const std::string&, const int&);
template void ModuleParamList::addParameter(const std::string&, std::string&, const std::string&, const std::string&);
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~