ImmutableCompositeFunction.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/CompositeFunction.h"
 
#include <map>
 
namespace Mantid {
namespace API {
class MANTID_API_DLL ImmutableCompositeFunction : public CompositeFunction {
public:
  /* Overriden methods */
 
  std::string name() const override { return "ImmutableCompositeFunction"; }
  void setParameter(size_t i, const double &value, bool explicitlySet = true) override {
    CompositeFunction::setParameter(i, value, explicitlySet);
  }
  void setParameterDescription(size_t i, const std::string &description) override {
    CompositeFunction::setParameterDescription(i, description);
  }
  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 getParameter(size_t i) const override { return CompositeFunction::getParameter(i); }
  double getParameter(const std::string &name) const override;
  size_t parameterIndex(const std::string &name) const override;
  std::string parameterName(size_t i) const override;
 
protected:
  using CompositeFunction::addFunction;
  void addFunction(IFunction *fun);
  void setAlias(const std::string &parName, const std::string &alias);
  void addDefaultTies(const std::string &ties);
  void addDefaultConstraints(const std::string &constraints);
  std::string writeToString(const std::string &parentLocalAttributesStr = "") const override;
 
private:
  std::map<std::string, size_t> m_aliases;
};
 
} // namespace API
} // namespace Mantid