AlgorithmObserver.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
#include "MantidPythonInterface/api/Algorithms/AlgorithmObserverAdapter.h"
#include "MantidPythonInterface/core/GetPointer.h"
 
#include <boost/python/class.hpp>
#include <boost/python/register_ptr_to_python.hpp>
 
using namespace Mantid::API;
using namespace Mantid::PythonInterface;
using namespace boost::python;
 
void observeFinish(AlgorithmObserver &self, const boost::python::object &alg) {
  const IAlgorithm_sptr &calg = boost::python::extract<IAlgorithm_sptr &>(alg);
  self.observeFinish(calg);
}
 
void observeError(AlgorithmObserver &self, const boost::python::object &alg) {
  const IAlgorithm_sptr &calg = boost::python::extract<IAlgorithm_sptr &>(alg);
  self.observeError(calg);
}
 
void observeProgress(AlgorithmObserver &self, const boost::python::object &alg) {
  const IAlgorithm_sptr &calg = boost::python::extract<IAlgorithm_sptr &>(alg);
  self.observeProgress(calg);
}
 
void stopObserving(AlgorithmObserver &self, const boost::python::object &alg) {
  const IAlgorithm_sptr &calg = boost::python::extract<IAlgorithm_sptr &>(alg);
  self.stopObserving(calg);
}
 
GET_POINTER_SPECIALIZATION(AlgorithmObserver)
 
void export_algorithm_observer() {
 
  register_ptr_to_python<std::shared_ptr<AlgorithmObserver>>();
 
  class_<AlgorithmObserver, bases<>, std::shared_ptr<AlgorithmObserverAdapter>, boost::noncopyable>(
      "AlgorithmObserver", "Observes Algorithm notifications: start,progress,finish,error.")
      .def("observeStarting", &AlgorithmObserver::observeStarting, arg("self"),
           "Observe the AlgorithmManager for starting algorithms.")
      .def("observeFinish", &observeFinish, (arg("self"), arg("alg")), "Observe algorithm for its finish notification.")
      .def("observeError", &observeError, (arg("self"), arg("alg")), "Observe algorithm for its error notification.")
      .def("observeProgress", &observeProgress, (arg("self"), arg("alg")),
           "Observe algorithm for its progress notification.")
      .def("stopObserving", &stopObserving, (arg("self"), arg("alg")), "Remove all observers from the algorithm.");
}