IJobRunner.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2021 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 "DllOption.h"
#include "MantidAPI/IAlgorithm_fwd.h"
 
#include <deque>
#include <memory>
#include <string>
 
namespace MantidQt::API {
class IConfiguredAlgorithm;
using IConfiguredAlgorithm_sptr = std::shared_ptr<IConfiguredAlgorithm>;
 
class EXPORT_OPT_MANTIDQT_COMMON JobRunnerSubscriber {
public:
  virtual ~JobRunnerSubscriber() = default;
 
  virtual void notifyBatchComplete(bool error) = 0;
  virtual void notifyBatchCancelled() = 0;
  virtual void notifyAlgorithmStarted(API::IConfiguredAlgorithm_sptr &algorithm) = 0;
  virtual void notifyAlgorithmComplete(API::IConfiguredAlgorithm_sptr &algorithm) = 0;
  virtual void notifyAlgorithmError(API::IConfiguredAlgorithm_sptr &algorithm, std::string const &message) = 0;
};
 
class EXPORT_OPT_MANTIDQT_COMMON IJobRunner {
public:
  virtual ~IJobRunner() = default;
  virtual void subscribe(JobRunnerSubscriber *notifyee) = 0;
  virtual void clearAlgorithmQueue() = 0;
  virtual void setAlgorithmQueue(std::deque<MantidQt::API::IConfiguredAlgorithm_sptr> algorithms) = 0;
  virtual void executeAlgorithmQueue() = 0;
  virtual void executeAlgorithm(MantidQt::API::IConfiguredAlgorithm_sptr algorithm) = 0;
  virtual void cancelAlgorithmQueue() = 0;
};
} // namespace MantidQt::API