IAlgorithm.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/IAlgorithm_fwd.h"
#include "MantidKernel/IPropertyManager.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Poco {
class AbstractObserver;
template <class T> class ActiveResult;
} // namespace Poco
 
namespace Mantid {
namespace API {
 
using AlgorithmID = void *;
 
enum class ExecutionState { Uninitialized, Initialized, Running, Finished };
enum class ResultState { NotFinished, Failed, Success };
 
class MANTID_API_DLL IAlgorithm : virtual public Kernel::IPropertyManager {
public:
  virtual const std::string name() const = 0;
 
  virtual int version() const = 0;
 
  virtual const std::string summary() const = 0;
 
  virtual const std::string category() const = 0;
 
  virtual const std::vector<std::string> categories() const = 0;
 
  virtual const std::string categorySeparator() const = 0;
 
  virtual const std::vector<std::string> seeAlso() const = 0;
 
  virtual const std::string aliasDeprecated() const = 0;
 
  virtual const std::string alias() const = 0;
 
  virtual const std::string helpURL() const = 0;
 
  virtual const std::string workspaceMethodName() const = 0;
  virtual const std::vector<std::string> workspaceMethodOn() const = 0;
  virtual const std::string workspaceMethodInputProperty() const = 0;
 
  virtual AlgorithmID getAlgorithmID() const = 0;
 
  virtual void initialize() = 0;
 
  virtual std::map<std::string, std::string> validateInputs() = 0;
 
  virtual bool execute() = 0;
 
  virtual Poco::ActiveResult<bool> executeAsync() = 0;
 
  virtual void executeAsChildAlg() = 0;
 
  virtual ExecutionState executionState() const = 0;
 
  virtual ResultState resultState() const = 0;
 
  virtual bool isInitialized() const = 0;
  virtual bool isExecuted() const = 0;
 
  virtual void cancel() = 0;
 
  virtual bool isRunning() const = 0;
 
  virtual bool isReadyForGarbageCollection() const = 0;
 
  virtual bool isChild() const = 0;
 
  virtual bool getAlwaysStoreInADS() const = 0;
 
  virtual void setChild(const bool isChild) = 0;
 
  virtual void enableHistoryRecordingForChild(const bool on) = 0;
  virtual void enableHistoryRecordingForProcessGroups(const bool on) = 0;
 
  virtual void setAlwaysStoreInADS(const bool doStore) = 0;
 
  virtual void setRethrows(const bool rethrow) = 0;
 
  virtual void addObserver(const Poco::AbstractObserver &observer) const = 0;
 
  virtual void removeObserver(const Poco::AbstractObserver &observer) const = 0;
 
  virtual void setLogging(const bool value) = 0;
  virtual bool isLogging() const = 0;
  virtual void setLoggingOffset(const int value) = 0;
  virtual int getLoggingOffset() const = 0;
  virtual void setAlgStartupLogging(const bool enabled) = 0;
  virtual bool getAlgStartupLogging() const = 0;
  virtual void setChildStartProgress(const double startProgress) const = 0;
  virtual void setChildEndProgress(const double endProgress) const = 0;
  virtual std::string toString() const = 0;
  virtual ::Json::Value toJson() const = 0;
 
private:
  using Kernel::IPropertyManager::asJson;
};
 
} // namespace API
} // namespace Mantid
 
// Instantiated and exported by API/src/PropertyWithValue.cpp
MANTID_API_EXTERN_TEMPLATE(Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::API::IAlgorithm>>);