AlgorithmProperty.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidKernel/Exception.h"
#include "MantidKernel/NullValidator.h"
#include "MantidKernel/PropertyWithValue.h"
 
#include <memory>
 
namespace Mantid {
namespace API {
//-------------------------------------------------------------------------
// Forward declarations
//-------------------------------------------------------------------------
class IAlgorithm;
 
#ifdef _WIN32
#pragma warning(push)
// Disable 'multiple assignment operators specified' warning for this class
//  - it's not an accident that we have more than one
#pragma warning(disable : 4522)
#endif
 
class MANTID_API_DLL AlgorithmProperty : public Kernel::PropertyWithValue<std::shared_ptr<IAlgorithm>> {
public:
  using HeldType = std::shared_ptr<IAlgorithm>;
 
  AlgorithmProperty(const std::string &propName,
                    Kernel::IValidator_sptr validator = Kernel::IValidator_sptr(new Kernel::NullValidator),
                    unsigned int direction = Kernel::Direction::Input);
 
  AlgorithmProperty(const AlgorithmProperty &) = default;
  // Unhide base class member that would be hidden by implicitly declared
  // assignment operator
  using Kernel::PropertyWithValue<HeldType>::operator=;
 
  inline AlgorithmProperty *clone() const override { return new AlgorithmProperty(*this); }
 
  AlgorithmProperty &operator+=(Kernel::Property const *) override {
    throw Kernel::Exception::NotImplementedError("+= operator is not implemented for AlgorithmProperty.");
  }
  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;
 
private:
  std::string setBaseValue(const HeldType &algm);
 
  // Cached string as value() can be called frequently
  std::string m_algmStr;
};
 
#ifdef _WIN32
#pragma warning(pop) // Re-enable the warning about multiple assignment operators
#endif
 
} // namespace API
} // namespace Mantid