IAlgorithm is the interface implemented by the Algorithm base class. More...

#include <IAlgorithm.h>

Inheritance diagram for Mantid::API::IAlgorithm:

Public Member Functions
virtual void	addObserver (const Poco::AbstractObserver &observer) const =0
	Add an observer for a notification. More...

virtual const std::string	alias () const =0
	function to return any aliases of the algorithm. More...

virtual const std::string	aliasDeprecated () const =0
	Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...

virtual void	cancel ()=0
	Raises the cancel flag. More...

virtual const std::vector< std::string >	categories () const =0
	Function to return all of the categories that contain this algorithm. More...

virtual const std::string	category () const =0
	function to return a category of the algorithm. More...

virtual const std::string	categorySeparator () const =0
	Function to return the separator token for the category string. More...

virtual void	enableHistoryRecordingForChild (const bool on)=0
	If true history will be recorded for a child. More...

virtual bool	execute ()=0
	System execution. More...

virtual void	executeAsChildAlg ()=0
	Execute as a Child Algorithm, with try/catch. More...

virtual Poco::ActiveResult< bool >	executeAsync ()=0
	Asynchronous execution of the algorithm. More...

virtual ExecutionState	executionState () const =0
	Gets the current execution state. More...

virtual AlgorithmID	getAlgorithmID () const =0
	Algorithm ID. More...

virtual bool	getAlgStartupLogging () const =0
	get the state of Logging of start and end messages More...

virtual bool	getAlwaysStoreInADS () const =0
	To query whether the output is stored in the analysis data service. More...

virtual int	getLoggingOffset () const =0
	returns the logging priority offset More...

virtual const std::string	helpURL () const =0
	function to return an optional URL for documentation. More...

virtual void	initialize ()=0
	Initialization method invoked by the framework. More...

virtual bool	isChild () const =0
	To query whether algorithm is a child. Default to false. More...

virtual bool	isExecuted () const =0
	Check whether the algorithm has been executed sucessfully. More...

virtual bool	isInitialized () const =0
	Check whether the algorithm is initialized properly. More...

virtual bool	isLogging () const =0
	returns the status of logging, True = enabled More...

virtual bool	isReadyForGarbageCollection () const =0
	True if the algorithm is ready for garbage collection. More...

virtual bool	isRunning () const =0
	True if the algorithm is running. More...

virtual const std::string	name () const =0
	function to return a name of the algorithm, must be overridden in all algorithms More...

virtual void	removeObserver (const Poco::AbstractObserver &observer) const =0
	Remove an observer. More...

virtual ResultState	resultState () const =0
	Gets the currnet result State. More...

virtual const std::vector< std::string >	seeAlso () const =0
	Function to return all of the seeAlso algorithms related to this algorithm. More...

virtual void	setAlgStartupLogging (const bool enabled)=0
	disable Logging of start and end messages More...

virtual void	setAlwaysStoreInADS (const bool doStore)=0
	Set whether we always store the output in the analysis data service. More...

virtual void	setChild (const bool isChild)=0
	To set whether algorithm is a child. More...

virtual void	setChildEndProgress (const double endProgress) const =0
	setting the child end progress More...

virtual void	setChildStartProgress (const double startProgress) const =0
	setting the child start progress More...

virtual void	setLogging (const bool value)=0
	Logging can be disabled by passing a value of false. More...

virtual void	setLoggingOffset (const int value)=0
	gets the logging priority offset More...

virtual void	setRethrows (const bool rethrow)=0
	To query whether an algorithm should rethrow exceptions when executing. More...

virtual const std::string	summary () const =0
	function returns a summary message that will be displayed in the default GUI, and in the help. More...

virtual ::Json::Value	toJson () const =0
	Serialize an algorithm as Json. More...

virtual std::string	toString () const =0
	Serialize an algorithm. More...

virtual std::map< std::string, std::string >	validateInputs ()=0
	Method checking errors on ALL the inputs, before execution. More...

virtual int	version () const =0
	function to return a version of the algorithm, must be overridden in all algorithms More...

Algorithms As Methods
virtual const std::string	workspaceMethodName () const =0

virtual const std::vector< std::string >	workspaceMethodOn () const =0
	Returns a set of class names that will have the method attached. More...

virtual const std::string	workspaceMethodInputProperty () const =0
	Returns the name of the input workspace property used by the calling object. More...

Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value	asJson (bool withDefaultValues=false) const =0
	Return the property manager serialized as a json object. More...

virtual std::string	asString (bool withDefaultValues=false) const =0
	Return the property manager serialized as a string. More...

virtual void	declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them) More...

void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties. More...

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator. More...

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties. More...

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties. More...

virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them) More...

virtual bool	existsProperty (const std::string &name) const =0
	Checks whether the named property is already in the list of managed property. More...

virtual void	filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0

virtual void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0

virtual std::vector< std::string >	getDeclaredPropertyNames () const noexcept=0
	Get the list of managed property names. More...

virtual Property *	getPointerToProperty (const std::string &name) const =0
	Get a pointer to property by name. More...

virtual const std::vector< Property * > &	getProperties () const =0
	Get the list of managed properties. More...

std::vector< Property * >	getPropertiesInGroup (const std::string &group) const
	Get the list of managed properties in a given group. More...

virtual TypedValue	getProperty (const std::string &name) const =0
	Get the value of a property. More...

virtual std::string	getPropertyValue (const std::string &name) const =0
	Get the value of a property as a string. More...

virtual size_t	propertyCount () const =0
	Returns the number of properties under management. More...

virtual void	removeProperty (const std::string &name, const bool delproperty=true)=0
	Removes the property from management. More...

virtual void	resetProperties ()=0

virtual void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
	Sets all the properties from a json object. More...

virtual void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
	Sets all properties from a string. More...

virtual void	setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0
	Sets all the declared properties from a string. More...

IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *. More...

IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string. More...

template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue. More...

template<typename T >
IPropertyManager *	setProperty (const std::string &name, std::unique_ptr< T > value)
	Templated method to set the value of a PropertyWithValue from a std::unique_ptr. More...

void	setPropertyGroup (const std::string &name, const std::string &group)
	Set the group for a given property. More...

virtual void	setPropertyOrdinal (const int &index, const std::string &value)=0
	Set the value of a property by an index. More...

void	setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)

virtual void	setPropertyValue (const std::string &name, const std::string &value)=0
	Sets property value from a string. More...

virtual void	setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0
	Sets property value from a Json::Value. More...

virtual void	splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0

virtual std::unique_ptr< Property >	takeProperty (const size_t index)=0
	Removes the property from management and returns a pointer to it. More...

void	updatePropertyValues (const IPropertyManager &other)
	Update values of the existing properties. More...

virtual bool	validateProperties () const =0
	Validates all the properties in the collection. More...

virtual	~IPropertyManager ()=default

Additional Inherited Members
Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void	afterPropertySet (const std::string &)
	Override this method to perform a custom action right after a property was set. More...

virtual void	clear ()=0
	Clears all properties under management. More...

virtual Property *	getPointerToPropertyOrdinal (const int &index) const =0
	Get a property by an index. More...

template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property. More...

template<>
MANTID_KERNEL_DLL PropertyManager_sptr	getValue (const std::string &name) const

template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr	getValue (const std::string &name) const

Detailed Description

IAlgorithm is the interface implemented by the Algorithm base class.

Concrete algorithms, derived from the Algorithm base class are controlled via this interface.

Author: Russell Taylor, Tessella Support Services plc; Based on the Gaudi class of the same name (see http://proj-gaudi.web.cern.ch/proj-gaudi/)

Date: 11/09/2007

Definition at line 45 of file IAlgorithm.h.

Member Function Documentation

◆ addObserver()

virtual void Mantid::API::IAlgorithm::addObserver ( const Poco::AbstractObserver & observer ) const

pure virtual

Add an observer for a notification.

Implemented in Mantid::API::Algorithm.

◆ alias()

virtual const std::string Mantid::API::IAlgorithm::alias ( ) const

pure virtual

function to return any aliases of the algorithm.

Referenced by Mantid::API::DeprecatedAlias::deprecationMessage(), and export_ialgorithm().

◆ aliasDeprecated()

virtual const std::string Mantid::API::IAlgorithm::aliasDeprecated ( ) const

pure virtual

Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ cancel()

virtual void Mantid::API::IAlgorithm::cancel ( )

pure virtual

Raises the cancel flag.

interuption_point() method if called inside exec() checks this flag and if true terminates the algorithm.

Implemented in Mantid::API::Algorithm, and Mantid::DataHandling::Load.

Referenced by export_ialgorithm().

◆ categories()

virtual const std::vector< std::string > Mantid::API::IAlgorithm::categories ( ) const

pure virtual

Function to return all of the categories that contain this algorithm.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ category()

virtual const std::string Mantid::API::IAlgorithm::category ( ) const

pure virtual

function to return a category of the algorithm.

Referenced by export_ialgorithm().

◆ categorySeparator()

virtual const std::string Mantid::API::IAlgorithm::categorySeparator ( ) const

pure virtual

Function to return the separator token for the category string.

Implemented in Mantid::API::Algorithm.

◆ enableHistoryRecordingForChild()

virtual void Mantid::API::IAlgorithm::enableHistoryRecordingForChild ( const bool on )

pure virtual

If true history will be recorded for a child.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ execute()

virtual bool Mantid::API::IAlgorithm::execute ( )

pure virtual

System execution.

This method invokes the exec() method of a concrete algorithm.

Implemented in Mantid::API::Algorithm.

◆ executeAsChildAlg()

virtual void Mantid::API::IAlgorithm::executeAsChildAlg ( )

pure virtual

Execute as a Child Algorithm, with try/catch.

Implemented in Mantid::API::Algorithm.

Referenced by Mantid::CurveFitting::Algorithms::QENSFitSimultaneous::performFit().

◆ executeAsync()

virtual Poco::ActiveResult< bool > Mantid::API::IAlgorithm::executeAsync ( )

pure virtual

Asynchronous execution of the algorithm.

Implemented in Mantid::API::Algorithm.

◆ executionState()

virtual ExecutionState Mantid::API::IAlgorithm::executionState ( ) const

pure virtual

Gets the current execution state.

Implemented in Mantid::API::Algorithm.

◆ getAlgorithmID()

virtual AlgorithmID Mantid::API::IAlgorithm::getAlgorithmID ( ) const

pure virtual

Algorithm ID.

Unmanaged algorithms return 0 (or NULL?) values. Managed ones have non-zero.

Implemented in Mantid::API::Algorithm.

Referenced by MantidQt::MantidWidgets::AlgorithmProgressModel::progressHandle(), MantidQt::MantidWidgets::AlgorithmProgressModel::removeFrom(), and MantidQt::MantidWidgets::AlgorithmProgressModel::startHandle().

◆ getAlgStartupLogging()

virtual bool Mantid::API::IAlgorithm::getAlgStartupLogging ( ) const

pure virtual

get the state of Logging of start and end messages

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ getAlwaysStoreInADS()

virtual bool Mantid::API::IAlgorithm::getAlwaysStoreInADS ( ) const

pure virtual

To query whether the output is stored in the analysis data service.

Implemented in Mantid::API::Algorithm.

◆ getLoggingOffset()

virtual int Mantid::API::IAlgorithm::getLoggingOffset ( ) const

pure virtual

returns the logging priority offset

Implemented in Mantid::API::Algorithm.

◆ helpURL()

virtual const std::string Mantid::API::IAlgorithm::helpURL ( ) const

pure virtual

function to return an optional URL for documentation.

Override if the algorithm is not part of the Mantid distribution

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ initialize()

virtual void Mantid::API::IAlgorithm::initialize ( )

pure virtual

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the init() method of the derived algorithm, and of any Child Algorithms which it creates.

Implemented in Mantid::API::Algorithm.

◆ isChild()

virtual bool Mantid::API::IAlgorithm::isChild ( ) const

pure virtual

To query whether algorithm is a child. Default to false.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ isExecuted()

virtual bool Mantid::API::IAlgorithm::isExecuted ( ) const

pure virtual

Check whether the algorithm has been executed sucessfully.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ isInitialized()

virtual bool Mantid::API::IAlgorithm::isInitialized ( ) const

pure virtual

Check whether the algorithm is initialized properly.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ isLogging()

virtual bool Mantid::API::IAlgorithm::isLogging ( ) const

pure virtual

returns the status of logging, True = enabled

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ isReadyForGarbageCollection()

virtual bool Mantid::API::IAlgorithm::isReadyForGarbageCollection ( ) const

pure virtual

True if the algorithm is ready for garbage collection.

Implemented in Mantid::API::Algorithm.

◆ isRunning()

virtual bool Mantid::API::IAlgorithm::isRunning ( ) const

pure virtual

True if the algorithm is running.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ name()

virtual const std::string Mantid::API::IAlgorithm::name ( ) const

pure virtual

function to return a name of the algorithm, must be overridden in all algorithms

Referenced by Mantid::API::Algorithm::copyNonWorkspaceProperties(), Mantid::API::DeprecatedAlias::deprecationMessage(), Mantid::API::DeprecatedAlgorithm::deprecationMsg(), export_ialgorithm(), and MantidQt::MantidWidgets::MuonFitPropertyBrowser::finishHandle().

◆ removeObserver()

virtual void Mantid::API::IAlgorithm::removeObserver ( const Poco::AbstractObserver & observer ) const

pure virtual

Remove an observer.

Implemented in Mantid::API::Algorithm.

Referenced by Mantid::API::AlgorithmObserver::stopObserving().

◆ resultState()

virtual ResultState Mantid::API::IAlgorithm::resultState ( ) const

pure virtual

Gets the currnet result State.

Implemented in Mantid::API::Algorithm.

◆ seeAlso()

virtual const std::vector< std::string > Mantid::API::IAlgorithm::seeAlso ( ) const

pure virtual

Function to return all of the seeAlso algorithms related to this algorithm.

Referenced by export_ialgorithm().

◆ setAlgStartupLogging()

virtual void Mantid::API::IAlgorithm::setAlgStartupLogging ( const bool enabled )

pure virtual

disable Logging of start and end messages

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ setAlwaysStoreInADS()

virtual void Mantid::API::IAlgorithm::setAlwaysStoreInADS ( const bool doStore )

pure virtual

Set whether we always store the output in the analysis data service.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ setChild()

virtual void Mantid::API::IAlgorithm::setChild ( const bool isChild )

pure virtual

To set whether algorithm is a child.

Parameters

isChild :: True - the algorithm is a child algorithm. False - this is a full managed algorithm.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ setChildEndProgress()

virtual void Mantid::API::IAlgorithm::setChildEndProgress ( const double endProgress ) const

pure virtual

setting the child end progress

Implemented in Mantid::API::Algorithm.

◆ setChildStartProgress()

virtual void Mantid::API::IAlgorithm::setChildStartProgress ( const double startProgress ) const

pure virtual

setting the child start progress

Implemented in Mantid::API::Algorithm.

◆ setLogging()

virtual void Mantid::API::IAlgorithm::setLogging ( const bool value )

pure virtual

Logging can be disabled by passing a value of false.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ setLoggingOffset()

virtual void Mantid::API::IAlgorithm::setLoggingOffset ( const int value )

pure virtual

gets the logging priority offset

Implemented in Mantid::API::Algorithm.

◆ setRethrows()

virtual void Mantid::API::IAlgorithm::setRethrows ( const bool rethrow )

pure virtual

To query whether an algorithm should rethrow exceptions when executing.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ summary()

virtual const std::string Mantid::API::IAlgorithm::summary ( ) const

pure virtual

function returns a summary message that will be displayed in the default GUI, and in the help.

Referenced by export_ialgorithm().

◆ toJson()

virtual ::Json::Value Mantid::API::IAlgorithm::toJson ( ) const

pure virtual

Serialize an algorithm as Json.

Implemented in Mantid::API::Algorithm.

◆ toString()

virtual std::string Mantid::API::IAlgorithm::toString ( ) const

pure virtual

Serialize an algorithm.

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

◆ validateInputs()

virtual std::map< std::string, std::string > Mantid::API::IAlgorithm::validateInputs ( )

pure virtual

Method checking errors on ALL the inputs, before execution.

For use mostly in dialogs.

◆ version()

virtual int Mantid::API::IAlgorithm::version ( ) const

pure virtual

function to return a version of the algorithm, must be overridden in all algorithms

Referenced by export_ialgorithm().

◆ workspaceMethodInputProperty()

virtual const std::string Mantid::API::IAlgorithm::workspaceMethodInputProperty ( ) const

pure virtual

Returns the name of the input workspace property used by the calling object.

Implemented in Mantid::Algorithms::CloneWorkspace, Mantid::Algorithms::ConvertAxisByFormula, Mantid::Algorithms::ConvertUnits, Mantid::Algorithms::ConvertUnitsUsingDetectorTable, Mantid::Algorithms::DeleteWorkspace, Mantid::Algorithms::Rebin, Mantid::Algorithms::RenameWorkspace, Mantid::API::Algorithm, and Mantid::DataHandling::MaskDetectors.

Referenced by export_ialgorithm().

◆ workspaceMethodName()

virtual const std::string Mantid::API::IAlgorithm::workspaceMethodName ( ) const

pure virtual

Returns a name that will be used when attached as a workspace method. Empty string indicates do not attach

Implemented in Mantid::Algorithms::CloneWorkspace, Mantid::Algorithms::ConvertAxisByFormula, Mantid::Algorithms::ConvertUnits, Mantid::Algorithms::ConvertUnitsUsingDetectorTable, Mantid::Algorithms::DeleteWorkspace, Mantid::Algorithms::InterpolatingRebin, Mantid::Algorithms::Rebin, Mantid::Algorithms::RenameWorkspace, Mantid::Algorithms::ResampleX, Mantid::API::Algorithm, and Mantid::DataHandling::MaskDetectors.

Referenced by export_ialgorithm().

◆ workspaceMethodOn()

virtual const std::vector< std::string > Mantid::API::IAlgorithm::workspaceMethodOn ( ) const

pure virtual

Returns a set of class names that will have the method attached.

Empty list indicates all types

Implemented in Mantid::API::Algorithm.

Referenced by export_ialgorithm().

The documentation for this class was generated from the following file:

Framework/API/inc/MantidAPI/IAlgorithm.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addObserver()

◆ alias()

◆ aliasDeprecated()

◆ cancel()

◆ categories()

◆ category()

◆ categorySeparator()

◆ enableHistoryRecordingForChild()

◆ execute()

◆ executeAsChildAlg()

◆ executeAsync()

◆ executionState()

◆ getAlgorithmID()

◆ getAlgStartupLogging()

◆ getAlwaysStoreInADS()

◆ getLoggingOffset()

◆ helpURL()

◆ initialize()

◆ isChild()

◆ isExecuted()

◆ isInitialized()

◆ isLogging()

◆ isReadyForGarbageCollection()

◆ isRunning()

◆ name()

◆ removeObserver()

◆ resultState()

◆ seeAlso()

◆ setAlgStartupLogging()

◆ setAlwaysStoreInADS()

◆ setChild()

◆ setChildEndProgress()

◆ setChildStartProgress()

◆ setLogging()

◆ setLoggingOffset()

◆ setRethrows()

◆ summary()

◆ toJson()

◆ toString()

◆ validateInputs()

◆ version()

◆ workspaceMethodInputProperty()

◆ workspaceMethodName()

◆ workspaceMethodOn()