AlgorithmAdapter.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
 
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
 
#include <boost/python/wrapper.hpp>
#include <map>
 
namespace Mantid {
namespace PythonInterface {
 
template <typename BaseAlgorithm> class AlgorithmAdapter : public BaseAlgorithm {
  using SuperClass = BaseAlgorithm;
 
public:
  AlgorithmAdapter(PyObject *self);
 
  AlgorithmAdapter() = delete;
 
  AlgorithmAdapter(const AlgorithmAdapter &) = delete;
 
  AlgorithmAdapter &operator=(const AlgorithmAdapter &) = delete;
 
  const std::string name() const override;
  int version() const override;
  const std::string summary() const override;
  const std::string category() const override;
  const std::vector<std::string> seeAlso() const override;
 
  const std::string alias() const override;
 
  const std::string aliasDeprecated() const override;
 
  const std::string helpURL() const override;
  bool isRunning() const override;
  void cancel() override;
  bool checkGroups() override;
  std::map<std::string, std::string> validateInputs() override;
 
  // -- Deprecated methods --
  void setWikiSummary(const std::string &summary);
 
  static void declarePyAlgProperty(boost::python::object &self, Kernel::Property *prop, const std::string &doc = "");
  static void declarePyAlgProperty(boost::python::object &self, const std::string &name,
                                   const boost::python::object &defaultValue,
                                   const boost::python::object &validator = boost::python::object(),
                                   const std::string &doc = "", const int direction = Kernel::Direction::Input);
 
  static void declarePyAlgProperty(boost::python::object &self, const std::string &name,
                                   const boost::python::object &defaultValue, const std::string &doc,
                                   const int direction = Kernel::Direction::Input);
 
  static void declarePyAlgProperty(boost::python::object &self, const std::string &name,
                                   const boost::python::object &defaultValue, const int direction);
 
protected:
  inline PyObject *getSelf() const { return m_self; }
 
private:
  void init() override;
  void exec() override;
 
  using SuperClass::declareProperty;
 
  PyObject *m_self;
  PyObject *m_isRunningObj;
 
  std::string m_wikiSummary;
};
} // namespace PythonInterface
} // namespace Mantid