FitParameter.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 "MantidGeometry/Instrument/Parameter.h"
#include "MantidKernel/Interpolation.h"
 
namespace Mantid {
namespace Geometry {
class MANTID_GEOMETRY_DLL FitParameter {
public:
  FitParameter() : m_value(0.0), m_tie(""), m_function("") {};
 
  double getValue(const double &at) const;
  double getValue() const;
  void setValue(double value) { m_value = value; }
  const std::string &getTie() const { return m_tie; }
  void setTie(const std::string &tie) { m_tie = tie; }
  std::string getConstraint() const;
  const std::string &getConstraintPenaltyFactor() const { return m_constraintPenaltyFactor; }
  void setConstraintMin(const std::string &constraintMin) { m_constraintMin = constraintMin; }
  void setConstraintMax(const std::string &constraintMax) { m_constraintMax = constraintMax; }
  void setConstraintPenaltyFactor(const std::string &constraintPenaltyFactor) {
    m_constraintPenaltyFactor = constraintPenaltyFactor;
  }
  const std::string &getFormula() const { return m_formula; }
  void setFormula(const std::string &formula) { m_formula = formula; }
  const std::string &getFormulaUnit() const { return m_formulaUnit; }
  void setFormulaUnit(const std::string &formulaUnit) { m_formulaUnit = formulaUnit; }
  const std::string &getResultUnit() const { return m_resultUnit; }
  void setResultUnit(const std::string &resultUnit) { m_resultUnit = resultUnit; }
  const std::string &getFunction() const { return m_function; }
  void setFunction(const std::string &function) { m_function = function; }
  const std::string &getName() const { return m_name; }
  void setName(const std::string &name) { m_name = name; }
  const Kernel::Interpolation &getLookUpTable() const { return m_lookUpTable; }
  void setLookUpTable(const Kernel::Interpolation &lookupTable) { m_lookUpTable = lookupTable; }
 
  void printSelf(std::ostream &os) const;
 
private:
  mutable double m_value;
  std::string m_tie;
  std::string m_constraintMin;           
  std::string m_constraintMax;           
  std::string m_constraintPenaltyFactor; 
  std::string m_function;
  std::string m_name;
  Kernel::Interpolation m_lookUpTable;
 
  std::string m_formula;     
  std::string m_formulaUnit; 
  std::string m_resultUnit;  
};
 
// defining operator << and >>
MANTID_GEOMETRY_DLL std::ostream &operator<<(std::ostream &, const FitParameter &);
MANTID_GEOMETRY_DLL std::istream &operator>>(std::istream &, FitParameter &);
 
// Instantiated and exported by Parameter.cpp
MANTID_GEOMETRY_EXTERN_TEMPLATE(ParameterType<FitParameter>);
 
} // namespace Geometry
} // namespace Mantid