ParameterReference.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 "MantidAPI/DllConfig.h"
#include <string>
 
namespace Mantid {
namespace API {
class IFunction;
class MANTID_API_DLL ParameterReference {
public:
  ParameterReference();
  ParameterReference(IFunction *fun, std::size_t index, bool isDefault = false);
  void setParameter(const double &value, bool isExplicitlySet = true);
  double getParameter() const;
  bool isDefault() const;
  bool isParameterOf(const IFunction *fun) const;
  virtual ~ParameterReference() = default;
  IFunction *getLocalFunction() const;
  std::size_t getLocalIndex() const;
  std::size_t parameterIndex() const;
  std::string parameterName() const;
  IFunction *ownerFunction() const;
 
protected:
  void reset(IFunction *fun, std::size_t index, bool isDefault = false);
 
private:
  IFunction *m_owner;
  IFunction *m_function;
  std::size_t m_index;
  bool m_isDefault;
};
 
} // namespace API
} // namespace Mantid