12#include "MantidAPI/DllConfig.h"
17class AbstractObserver;
49 virtual const std::string
name()
const = 0;
57 virtual const std::string
summary()
const = 0;
60 virtual const std::string
category()
const = 0;
63 virtual const std::vector<std::string>
categories()
const = 0;
69 virtual const std::vector<std::string>
seeAlso()
const = 0;
75 virtual const std::string
alias()
const = 0;
79 virtual const std::string
helpURL()
const = 0;
163 virtual void addObserver(
const Poco::AbstractObserver &observer)
const = 0;
187 virtual ::Json::Value
toJson()
const = 0;
190 using Kernel::IPropertyManager::asJson;
double value
The value of the point.
IAlgorithm is the interface implemented by the Algorithm base class.
virtual const std::string workspaceMethodInputProperty() const =0
Returns the name of the input workspace property used by the calling object.
virtual std::string toString() const =0
Serialize an algorithm.
virtual ::Json::Value toJson() const =0
Serialize an algorithm as Json.
virtual Poco::ActiveResult< bool > executeAsync()=0
Asynchronous execution of the algorithm.
virtual bool isExecuted() const =0
Check whether the algorithm has been executed sucessfully.
virtual bool isInitialized() const =0
Check whether the algorithm is initialized properly.
virtual const std::string alias() const =0
function to return any aliases of the algorithm.
virtual void removeObserver(const Poco::AbstractObserver &observer) const =0
Remove an observer.
virtual bool isChild() const =0
To query whether algorithm is a child. Default to false.
virtual int version() const =0
function to return a version of the algorithm, must be overridden in all algorithms
virtual const std::string aliasDeprecated() const =0
Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date.
virtual const std::string categorySeparator() const =0
Function to return the separator token for the category string.
virtual const std::string helpURL() const =0
function to return an optional URL for documentation.
virtual void setChildStartProgress(const double startProgress) const =0
setting the child start progress
virtual const std::vector< std::string > categories() const =0
Function to return all of the categories that contain this algorithm.
virtual bool isLogging() const =0
returns the status of logging, True = enabled
virtual ExecutionState executionState() const =0
Gets the current execution state.
virtual const std::vector< std::string > seeAlso() const =0
Function to return all of the seeAlso algorithms related to this algorithm.
virtual bool isRunning() const =0
True if the algorithm is running.
virtual const std::string category() const =0
function to return a category of the algorithm.
virtual bool isReadyForGarbageCollection() const =0
True if the algorithm is ready for garbage collection.
virtual void setChild(const bool isChild)=0
To set whether algorithm is a child.
virtual const std::string workspaceMethodName() const =0
virtual void executeAsChildAlg()=0
Execute as a Child Algorithm, with try/catch.
virtual const std::vector< std::string > workspaceMethodOn() const =0
Returns a set of class names that will have the method attached.
virtual bool getAlgStartupLogging() const =0
get the state of Logging of start and end messages
virtual const std::string summary() const =0
function returns a summary message that will be displayed in the default GUI, and in the help.
virtual void enableHistoryRecordingForChild(const bool on)=0
If true history will be recorded for a child.
virtual bool getAlwaysStoreInADS() const =0
To query whether the output is stored in the analysis data service.
virtual void setLogging(const bool value)=0
Logging can be disabled by passing a value of false.
virtual void cancel()=0
Raises the cancel flag.
virtual void setLoggingOffset(const int value)=0
gets the logging priority offset
virtual void setAlwaysStoreInADS(const bool doStore)=0
Set whether we always store the output in the analysis data service.
virtual void setRethrows(const bool rethrow)=0
To query whether an algorithm should rethrow exceptions when executing.
virtual void setAlgStartupLogging(const bool enabled)=0
disable Logging of start and end messages
virtual const std::string name() const =0
function to return a name of the algorithm, must be overridden in all algorithms
virtual bool execute()=0
System execution.
virtual void setChildEndProgress(const double endProgress) const =0
setting the child end progress
virtual void addObserver(const Poco::AbstractObserver &observer) const =0
Add an observer for a notification.
virtual int getLoggingOffset() const =0
returns the logging priority offset
virtual std::map< std::string, std::string > validateInputs()=0
Method checking errors on ALL the inputs, before execution.
virtual AlgorithmID getAlgorithmID() const =0
Algorithm ID.
virtual ResultState resultState() const =0
Gets the currnet result State.
virtual void initialize()=0
Initialization method invoked by the framework.
Interface to PropertyManager.
ResultState
The validity of the results of the algorithm object.
ExecutionState
The current state of the algorithm object.
void * AlgorithmID
As we have multiple interfaces to the same logical algorithm we need a way of uniquely identifying ma...
Helper class which provides the Collimation Length for SANS instruments.