FunctionParameterDecorator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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
 
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/IFunction.h"
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL FunctionParameterDecorator : virtual public IFunction {
public:
  // MSVC 2015 segfaults without this default constructor.
  // still segfaults with = default
  FunctionParameterDecorator() : IFunction(), m_wrappedFunction() {}
  void setDecoratedFunction(const std::string &wrappedFunctionName);
  IFunction_sptr getDecoratedFunction() const;
 
  IFunction_sptr clone() const override;
 
  void setWorkspace(std::shared_ptr<const Workspace> ws) override;
  void setMatrixWorkspace(std::shared_ptr<const MatrixWorkspace> workspace, size_t wi, double startX,
                          double endX) override;
 
  void setParameter(size_t i, const double &value, bool explicitlySet = true) override;
  void setParameterDescription(size_t i, const std::string &description) override;
  double getParameter(size_t i) const override;
  void setParameter(const std::string &name, const double &value, bool explicitlySet = true) override;
  void setParameterDescription(const std::string &name, const std::string &description) override;
 
  double activeParameter(size_t i) const override;
  void setActiveParameter(size_t i, double value) override;
 
  double getParameter(const std::string &name) const override;
  bool hasParameter(const std::string &name) const override;
  size_t nParams() const override;
  size_t parameterIndex(const std::string &name) const override;
  std::string parameterName(size_t i) const override;
  std::string parameterDescription(size_t i) const override;
  bool isExplicitlySet(size_t i) const override;
  double getError(size_t i) const override;
  double getError(const std::string &name) const override;
  void setError(size_t i, double err) override;
  void setError(const std::string &name, double err) override;
 
  size_t getParameterIndex(const ParameterReference &ref) const override;
 
  size_t nAttributes() const override;
  std::vector<std::string> getAttributeNames() const override;
  IFunction::Attribute getAttribute(const std::string &attName) const override;
  void setAttribute(const std::string &attName, const IFunction::Attribute &attValue) override;
  bool hasAttribute(const std::string &attName) const override;
 
  void tie(const std::string &parName, const std::string &expr, bool isDefault = false) override;
  void applyTies() override;
  void clearTies() override;
  void removeTie(const std::string &parName) override;
  bool removeTie(size_t i) override;
  ParameterTie *getTie(size_t i) const override;
 
  void addConstraint(std::unique_ptr<IConstraint> ic) override;
  IConstraint *getConstraint(size_t i) const override;
  void removeConstraint(const std::string &parName) override;
  void setUpForFit() override;
 
protected:
  void init() override {}
 
  void throwIfNoFunctionSet() const;
 
  void declareParameter(const std::string &name, double initValue, const std::string &description) override;
 
  void addTie(std::unique_ptr<ParameterTie>) override;
  void setParameterStatus(size_t i, ParameterStatus status) override;
  ParameterStatus getParameterStatus(size_t i) const override;
 
  virtual void beforeDecoratedFunctionSet(const IFunction_sptr &fn);
  void setDecoratedFunctionPrivate(const IFunction_sptr &fn);
 
  IFunction_sptr m_wrappedFunction;
};
 
using FunctionParameterDecorator_sptr = std::shared_ptr<FunctionParameterDecorator>;
 
} // namespace API
} // namespace Mantid