FunctionProperty.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 "MantidAPI/DllConfig.h"
#include "MantidAPI/IFunction.h"
#include "MantidAPI/WorkspaceProperty.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/PropertyWithValue.h"
 
#include <string>
 
namespace Mantid {
namespace API {
class MANTID_API_DLL FunctionProperty : public Kernel::PropertyWithValue<std::shared_ptr<IFunction>> {
public:
  FunctionProperty(const std::string &name, const unsigned int direction = Kernel::Direction::Input,
                   const PropertyMode::Type optional = PropertyMode::Type::Mandatory);
 
  FunctionProperty(const FunctionProperty &right) = default;
 
  FunctionProperty &operator=(const FunctionProperty &right) = default;
 
  FunctionProperty &operator=(const std::shared_ptr<IFunction> &value) override;
 
  FunctionProperty &operator+=(Kernel::Property const *) override;
 
  FunctionProperty *clone() const override { return new FunctionProperty(*this); }
 
  std::string value() const override;
 
  Json::Value valueAsJson() const override;
 
  std::string getDefault() const override;
 
  std::string setValue(const std::string &value) override;
 
  std::string setValueFromJson(const Json::Value &value) override;
 
  std::string isValid() const override;
 
  bool isDefault() const override;
 
  const Kernel::PropertyHistory createHistory() const override;
 
private:
  bool isOptional() const;
 
  PropertyMode::Type m_optional;
  std::string m_definition;
};
 
} // namespace API
} // namespace Mantid