Parameter.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidGeometry/Instrument/Parameter.h"
#include "MantidGeometry/Instrument/FitParameter.h"
#include "MantidGeometry/Instrument/ParameterFactory.h"
#include "MantidKernel/Quat.h"
#include "MantidKernel/RegistrationHelper.h"
#include "MantidKernel/V3D.h"
#include "MantidKernel/WarningSuppressions.h"
#include <sstream>
#include <type_traits>
 
/* Register classes into the factory
 *
 */
#define DECLARE_PARAMETER(classname, classtype)                                                                        \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper register_par_##classname(                                                         \
      ((Mantid::Geometry::ParameterFactory::subscribe<Mantid::Geometry::ParameterType<classtype>>(#classname)), 0));   \
  }
 
namespace Mantid::Geometry {
 
template <class Type> std::string ParameterType<Type>::asString() const {
  std::ostringstream str;
  if constexpr (std::is_same_v<Type, double> || std::is_same_v<Type, Kernel::V3D>) {
    str << std::setprecision(std::numeric_limits<double>::digits10);
  }
  str << m_value;
  return str.str();
}
 
// The headers declare these with MANTID_GEOMETRY_EXTERN_TEMPLATE, which already carries the export
// attribute, so gcc warns that the one here is ignored.
GNU_DIAG_OFF("attributes")
template class MANTID_GEOMETRY_DLL ParameterType<int>;
template class MANTID_GEOMETRY_DLL ParameterType<double>;
template class MANTID_GEOMETRY_DLL ParameterType<bool>;
template class MANTID_GEOMETRY_DLL ParameterType<std::string>;
template class MANTID_GEOMETRY_DLL ParameterType<Kernel::V3D>;
template class MANTID_GEOMETRY_DLL ParameterType<Kernel::Quat>;
template class MANTID_GEOMETRY_DLL ParameterType<FitParameter>;
GNU_DIAG_ON("attributes")
 
// Initialize the static map
ParameterFactory::FactoryMap ParameterFactory::s_map;
 
std::string Parameter::getShortDescription() const {
  size_t pos = m_description.find('.');
  if (pos == std::string::npos) {
    return std::string(m_description);
  } else {
    if (pos > 0) {
      return m_description.substr(0, pos + 1);
    } else {
      return std::string("");
    }
  }
}
 
std::shared_ptr<Parameter> ParameterFactory::create(const std::string &className, const std::string &name,
                                                    const std::string &visible) {
  std::shared_ptr<Parameter> p;
  FactoryMap::const_iterator it = s_map.find(className);
  if (it != s_map.end())
    p = it->second->createInstance();
  else
    throw std::runtime_error("ParameterFactory:" + className + " is not registered.\n");
  p->m_name = name;
  p->m_type = className;
  p->m_visible = visible == "true" ? true : false;
  return p;
}
 
} // namespace Mantid::Geometry
 
DECLARE_PARAMETER(int, int)
DECLARE_PARAMETER(double, double)
DECLARE_PARAMETER(bool, bool)
DECLARE_PARAMETER(string, std::string)
DECLARE_PARAMETER(V3D, Mantid::Kernel::V3D)
DECLARE_PARAMETER(Quat, Mantid::Kernel::Quat)
DECLARE_PARAMETER(fitting, Mantid::Geometry::FitParameter)