XMLInstrumentParameter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidGeometry/DllConfig.h"
#include "MantidKernel/Interpolation.h"
#include "MantidKernel/TimeROI.h"
#include <string>
 
namespace Mantid {
 
namespace Kernel {
template <typename TYPE> class TimeSeriesProperty;
}
 
namespace Geometry {
//--------------------------------------------------------------------------
// Forward declarations
//--------------------------------------------------------------------------
class IComponent;
 
class MANTID_GEOMETRY_DLL XMLInstrumentParameter {
public:
  XMLInstrumentParameter(std::string logfileID, std::string value, std::shared_ptr<Kernel::Interpolation> interpolation,
                         std::string formula, std::string formulaUnit, std::string resultUnit, std::string paramName,
                         std::string type, std::string tie, std::vector<std::string> constraint,
                         std::string &penaltyFactor, std::string fitFunc, std::string extractSingleValueAs,
                         std::string eq, const Geometry::IComponent *comp, double angleConvertConst,
                         const std::string &description, std::string visible);
 
  // XML attributes from instrument definition file or instrument parameter file
  const std::string m_logfileID; 
  const std::string m_value;     
  const std::string m_paramName;               
  const std::string m_type;                    
  const std::string m_tie;                     
  const std::vector<std::string> m_constraint; 
  std::string m_penaltyFactor;         
  const std::string m_fittingFunction; 
  const std::string m_formula; 
  const std::string m_formulaUnit; 
  const std::string m_resultUnit;  
  std::shared_ptr<Kernel::Interpolation> m_interpolation; 
  const std::string m_extractSingleValueAs;               
  const std::string m_eq; 
  const Geometry::IComponent *m_component; 
 
  double createParamValue(const Mantid::Kernel::TimeSeriesProperty<double> *logData, const Kernel::TimeROI *) const;
 
  double m_angleConvertConst;
  const std::string m_description;
  const std::string m_visible;
};
 
} // namespace Geometry
} // namespace Mantid