Base class from which all concrete algorithm classes should be derived. More...

#include <Algorithm.h>

Inheritance diagram for Mantid::API::Algorithm:

Classes
class	AlgorithmNotification
	Base class for algorithm notifications. More...

class	CancelException
	CancelException is thrown to cancel execution of the algorithm. More...

class	ErrorNotification
	ErrorNotification is sent when an exception is caught during execution of the algorithm. More...

class	FinishedNotification
	FinishedNotification is sent after the algorithm finishes its execution. More...

class	ProgressNotification
	An algorithm can report its progress by sending ProgressNotification. More...

class	StartedNotification
	StartedNotification is sent when the algorithm begins execution. More...

Public Member Functions
	Algorithm ()
	Constructor.

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor.

IAlgorithm methods
void	initialize () override
	Initialization method invoked by the framework.

bool	execute () override final
	The actions to be performed by the algorithm on a dataset.

void	addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)

void	executeAsChildAlg () override
	Execute as a Child Algorithm.

std::map< std::string, std::string >	validateInputs () override
	Perform validation of ALL the input properties of the algorithm.

ExecutionState	executionState () const override
	Gets the current execution state.

ResultState	resultState () const override
	Gets the current result State.

bool	isInitialized () const override
	Has the Algorithm already been initialized.

bool	isExecuted () const override
	Has the Algorithm already been executed successfully.

bool	isRunning () const override
	True if the algorithm is running.

bool	isReadyForGarbageCollection () const override
	True if the algorithm is ready for garbage collection.

bool	isChild () const override
	To query whether algorithm is a child.

void	setChild (const bool isChild) override
	To set whether algorithm is a child.

void	enableHistoryRecordingForChild (const bool on) override
	Change the state of the history recording flag.

bool	isRecordingHistoryForChild ()

void	setAlwaysStoreInADS (const bool doStore) override
	Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms.

bool	getAlwaysStoreInADS () const override
	Returns true if we always store in the AnalysisDataService.

void	setRethrows (const bool rethrow) override
	Set whether the algorithm will rethrow exceptions.

Asynchronous Execution
Poco::ActiveResult< bool >	executeAsync () override
	Asynchronous execution.

void	addObserver (const Poco::AbstractObserver &observer) const override
	Add an observer for a notification.

void	removeObserver (const Poco::AbstractObserver &observer) const override
	Remove an observer.

void	cancel () override
	Raises the cancel flag.

bool	getCancel () const
	Returns the cancellation state.

Kernel::Logger &	getLogger () const
	Returns a reference to the logger.

void	setLogging (const bool value) override
	Logging can be disabled by passing a value of false.

bool	isLogging () const override
	returns the status of logging, True = enabled

void	setLoggingOffset (const int value) override
	gets the logging priority offset

int	getLoggingOffset () const override
	returns the logging priority offset

void	setAlgStartupLogging (const bool enabled) override
	disable Logging of start and end messages

bool	getAlgStartupLogging () const override
	get the state of Logging of start and end messages

void	setChildStartProgress (const double startProgress) const override
	setting the child start progress

void	setChildEndProgress (const double endProgress) const override
	setting the child end progress

Algorithms As Methods
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
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).

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.

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).

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.

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.

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.

virtual void	filterByProperty (Mantid::Kernel::LogFilter *, const std::vector< std::string > &)

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

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

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

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

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.

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

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

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

virtual	~IPropertyManager ()=default

Serialization functions
using	WorkspaceVector = std::vector< std::shared_ptr< Workspace > >

std::string	toString () const override
	Serialize an object to a string.

::Json::Value	toJson () const override
	Serialize an object to a json object.

virtual std::shared_ptr< Algorithm >	createChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
	Create a Child Algorithm.

void	setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true)
	Setup algorithm as child algorithm.

void	trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist)
	set whether we wish to track the child algorithm's history and pass it the parent object to fill.

void	findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const
	Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output)

virtual bool	checkGroups ()
	Check the input workspace properties for groups.

virtual bool	processGroups ()
	Process WorkspaceGroup inputs.

void	copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum)
	Copy all the non-workspace properties from this to alg.

void	declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add a property to the list of managed properties.

void	declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add or replace property in the list of managed properties.

void	resetProperties () override
	Reset property values back to initial values (blank or default values)

void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by one string of values, separated by semicolons.

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

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

void	setPropertyValue (const std::string &name, const std::string &value) override
	Set the value of a property by string N.B.

void	setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
	Set the value of a property by Json::Value object.

void	setPropertyOrdinal (const int &index, const std::string &value) override
	Set the value of a property by an index N.B.

virtual void	copyPropertiesFrom (const Algorithm &alg)
	Make m_properties point to the same PropertyManager as alg.m_properties.

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

bool	validateProperties () const override
	Validates all the properties in the collection.

size_t	propertyCount () const override
	Count the number of properties under management.

std::string	getPropertyValue (const std::string &name) const override
	Get the value of a property as a string.

const std::vector< Kernel::Property * > &	getProperties () const override
	Get the list of managed properties.

std::vector< std::string >	getDeclaredPropertyNames () const noexcept override
	Return the list of declared property names.

TypedValue	getProperty (const std::string &name) const override
	Get the value of a property.

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

::Json::Value	asJson (bool withDefaultValues=false) const override
	Return the property manager serialized as a json object.

bool	isDefault (const std::string &name) const

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

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

void	clear () override
	Clears all properties under management.

void	afterPropertySet (const std::string &) override
	Override this method to perform a custom action right after a property was set.

Kernel::Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name.

Kernel::Property *	getPointerToPropertyOrdinal (const int &index) const override
	Get a property by an index.

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

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.

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.

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.

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).

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).

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.

static IAlgorithm_sptr	fromString (const std::string &input)
	De-serialize an object from a string.

static IAlgorithm_sptr	fromJson (const Json::Value &input)
	De-serialize an object from a Json.

static IAlgorithm_sptr	fromHistory (const AlgorithmHistory &history)
	Construct an object from a history entry.

virtual void	init ()=0
	Virtual method - must be overridden by concrete algorithm.

virtual void	exec ()=0
	Virtual method - must be overridden by concrete algorithm.

virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm.

void	cacheWorkspaceProperties ()
	Go through the properties and cache the input/output workspace properties for later use.

void	cacheInputWorkspaceHistories ()
	Cache the histories of any input workspaces so they can be copied over after algorithm completion.

void	setExecutionState (const ExecutionState state)
	Sets the current execution state.

void	setResultState (const ResultState state)
	Sets the result execution state.

void	store ()
	Stores any output workspaces into the AnalysisDataService.

Algorithm Information
bool	calledByAlias = false
	Flag to indicate if the algorithm is called by its alias.

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

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

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

const std::string	category () const override
	function to return a category of the algorithm.

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

const std::string	categorySeparator () const override
	Function to return the separator token for the category string.

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

const std::string	alias () const override
	function to return any aliases to the algorithm; A default implementation is provided

const std::string	aliasDeprecated () const override
	Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date.

const std::string	helpURL () const override
	function to return URL for algorithm documentation; A default implementation is provided.

template<typename T , typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet >	getWorkspaceAndIndices (const std::string &name) const
	Mechanism for retriving the index property.

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)
	Mechanism for setting the index property with a workspace shared pointer.

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)
	Mechanism for setting the index property with a workspace shared pointer.

const std::string	workspaceMethodName () const override

const std::vector< std::string >	workspaceMethodOn () const override

const std::string	workspaceMethodInputProperty () const override

AlgorithmID	getAlgorithmID () const override
	Algorithm ID.

Progress Reporting functions
class	Progress

class	WorkspaceHistory

std::atomic< bool >	m_cancel
	Set to true to stop execution.

std::atomic< bool >	m_parallelException
	Set if an exception is thrown, and not caught, within a parallel region.

std::vector< IWorkspaceProperty * >	m_inputWorkspaceProps
	All the WorkspaceProperties that are Input or InOut. Set in execute()

std::shared_ptr< AlgorithmHistory >	m_history
	Pointer to the history for the algorithm being executed.

Kernel::Logger	m_log
	Logger for this algorithm.

Kernel::Logger &	g_log

std::shared_ptr< AlgorithmHistory >	m_parentHistory
	Pointer to the parent history object (if set)

std::vector< WorkspaceVector >	m_unrolledInputWorkspaces
	One vector of workspaces for each input workspace property.

size_t	m_groupSize
	Size of the group(s) being processed.

bool	m_usingBaseProcessGroups = false
	distinguish between base processGroups() and overriden/algorithm specific versions

static size_t	g_execCount = 0
	Counter to keep track of algorithm execution order.

std::unique_ptr< Poco::ActiveMethod< bool, Poco::Void, Algorithm, Poco::ActiveStarter< Algorithm > > >	m_executeAsync
	Poco::ActiveMethod used to implement asynchronous execution.

std::unique_ptr< Poco::NotificationCenter >	m_notificationCenter
	Sends notifications to observers.

std::unique_ptr< Poco::NObserver< Algorithm, ProgressNotification > >	m_progressObserver
	Child algorithm progress observer.

std::atomic< ExecutionState >	m_executionState
	the current execution state

std::atomic< ResultState >	m_resultState
	the current result State

bool	m_isChildAlgorithm
	Algorithm is a child algorithm.

bool	m_recordHistoryForChild
	Flag to indicate whether history should be recorded.

bool	m_alwaysStoreInADS
	Always store in the ADS, even for child algos.

bool	m_runningAsync
	Algorithm is running asynchronously.

bool	m_rethrow
	Algorithm should rethrow exceptions while executing.

bool	m_isAlgStartupLoggingEnabled

double	m_startChildProgress
	Whether to log alg startup and closedown messages from the base class (default = true)

double	m_endChildProgress
	Keeps value for algorithm's progress at Child Algorithm's finish.

AlgorithmID	m_algorithmID
	Algorithm ID for managed algorithms.

std::vector< std::weak_ptr< IAlgorithm > >	m_ChildAlgorithms
	A list of weak pointers to any child algorithms created.

WorkspaceVector	m_readLockedWorkspaces
	Vector of all the workspaces that have been read-locked.

WorkspaceVector	m_writeLockedWorkspaces
	Vector of all the workspaces that have been write-locked.

std::vector< IWorkspaceProperty * >	m_outputWorkspaceProps
	All the WorkspaceProperties that are Output or InOut. Set in execute()

std::vector< IWorkspaceProperty * >	m_pureOutputWorkspaceProps
	All the WorkspaceProperties that are Output (not inOut). Set in execute()

std::vector< std::shared_ptr< WorkspaceGroup > >	m_groupWorkspaces
	Pointer to the WorkspaceGroup (if any) for each input workspace property.

int	m_singleGroup
	If only one input is a group, this is its index. -1 if they are all groups.

bool	m_groupsHaveSimilarNames
	All the groups have similar names (group_1, group_2 etc.)

std::vector< Workspace_sptr >	m_inputWorkspaceHistories
	Store a pointer to the input workspace histories so they can be copied to the outputs to avoid anything being overwritten.

std::vector< std::string >	m_reservedList
	Reserved property names.

Mantid::Types::Core::DateAndTime	m_gcTime
	The earliest this class should be considered for garbage collection.

Mantid::Kernel::PropertyManagerOwner	m_properties

void	progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
	Sends ProgressNotification.

void	interruption_point ()
	This is called during long-running operations, and check if the algorithm has requested that it be cancelled.

Poco::NotificationCenter &	notificationCenter () const
	Return a reference to the algorithm's notification dispatcher.

void	handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
	Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm.

const Poco::AbstractObserver &	progressObserver () const
	Return a reference to the algorithm's object that is reporting progress.

bool	isWorkspaceProperty (const Kernel::Property *const prop) const
	checks the property is a workspace property

bool	trackingHistory ()
	get whether we are tracking the history for this algorithm,

virtual void	fillHistory ()
	Copy workspace history from input workspaces to output workspaces and record the history for ths algorithm.

void	fillHistory (const std::vector< Workspace_sptr > &outputWorkspaces)
	Copy workspace history from input workspaces to provided vector of output workspaces.

virtual void	setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
	Virtual method to set the non workspace properties for this algorithm.

template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
void	declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)
	Declare a property which defines the workspace and allowed index types, as well as a property for capturing the indices all at once.

template<typename NumT >
static bool	isEmpty (const NumT toCheck)
	checks that the value was not set by users, uses the value in empty double/int.

template<typename T1 , typename T2 , typename WsType >
void	doSetInputProperties (const std::string &name, const T1 &wksp, IndexType type, const T2 &list)

void	lockWorkspaces ()
	Go through the workspace properties of this algorithm and lock the workspaces for reading or writing.

void	unlockWorkspaces ()
	Unlock any previously locked workspaces.

void	clearWorkspaceCaches ()
	Clear any internal workspace handles so that workspaces will be deleted promptly after a managed algorithm finishes.

void	linkHistoryWithLastChild ()
	Link the name of the output workspaces on this parent algorithm.

void	logAlgorithmInfo () const
	Sends out algorithm parameter information to the logger.

bool	executeInternal ()
	Invoced internally in execute()

bool	executeAsyncImpl (const Poco::Void &i)
	Callback when an algorithm is executed asynchronously.

bool	doCallProcessGroups (Mantid::Types::Core::DateAndTime &start_time)
	Calls process groups with the required timing checks and algorithm execution finalization steps.

void	reportCompleted (const double &duration, const bool groupProcessing=false)
	Report that the algorithm has completed.

void	registerFeatureUsage () const
	Registers the usage of the algorithm with the UsageService.

bool	isCompoundProperty (const std::string &name) const

Additional Inherited Members
Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property.

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

Base class from which all concrete algorithm classes should be derived.

In order for a concrete algorithm class to do anything useful the methods init() & exec() should be overridden.

Further text from Gaudi file....... The base class provides utility methods for accessing standard services (event data service etc.); for declaring properties which may be configured by the job options service; and for creating Child Algorithms. The only base class functionality which may be used in the constructor of a concrete algorithm is the declaration of member variables as properties. All other functionality, i.e. the use of services and the creation of Child Algorithms, may be used only in initialise() and afterwards (see the Gaudi user guide).

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: 12/09/2007

Definition at line 76 of file Algorithm.h.

Member Typedef Documentation

◆ WorkspaceVector

using Mantid::API::Algorithm::WorkspaceVector = std::vector<std::shared_ptr<Workspace> >

Definition at line 282 of file Algorithm.h.

Constructor & Destructor Documentation

◆ Algorithm() [1/2]

Mantid::API::Algorithm::Algorithm ( )

Constructor.

Definition at line 111 of file Algorithm.cpp.

◆ Algorithm() [2/2]

Mantid::API::Algorithm::Algorithm ( const Algorithm & )

delete

◆ ~Algorithm()

Mantid::API::Algorithm::~Algorithm ( )

overridedefault

Virtual destructor.

Member Function Documentation

◆ addObserver()

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

overridevirtual

Add an observer for a notification.

Add an observer to a notification.

Parameters

observer :: Reference to the observer to add

Implements Mantid::API::IAlgorithm.

Definition at line 220 of file Algorithm.cpp.

References notificationCenter().

◆ addTimer()

void Mantid::API::Algorithm::addTimer	(	const std::string &	name,
		const Kernel::time_point_ns &	begin,
		const Kernel::time_point_ns &	end
	)

Definition at line 29 of file AlgorithmExecuteProfile.cpp.

References name().

Referenced by Mantid::Algorithms::Bin2DPowderDiffraction::createOutputWorkspace(), Mantid::Algorithms::FilterEvents::createOutputWorkspaces(), Mantid::Algorithms::Bin2DPowderDiffraction::exec(), Mantid::Algorithms::FilterEvents::exec(), Mantid::DataHandling::CompressEvents::exec(), Mantid::Algorithms::MaskBins::execEvent(), Mantid::Algorithms::FilterEvents::filterEvents(), and Mantid::Algorithms::RemovePromptPulse::getTofRange().

◆ afterPropertySet()

void Mantid::API::Algorithm::afterPropertySet ( const std::string & name )

overridevirtual

Override this method to perform a custom action right after a property was set.

The argument is the property name. Default - do nothing.

Parameters

name	:: A property name.

Reimplemented from Mantid::Kernel::IPropertyManager.

Reimplemented in Mantid::CurveFitting::IFittingAlgorithm.

Definition at line 2023 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::afterPropertySet(), m_properties, and name().

Referenced by setPropertyOrdinal(), setPropertyValue(), and setPropertyValueFromJson().

◆ alias()

const std::string Mantid::API::Algorithm::alias ( ) const

inlineoverridevirtual

function to return any aliases to the algorithm; A default implementation is provided

Implements Mantid::API::IAlgorithm.

Reimplemented in Mantid::DataHandling::CreateSampleShape, Mantid::DataHandling::Load, Mantid::DataHandling::LoadEventPreNexus2, Mantid::DataHandling::LoadPreNexusMonitors, Mantid::DataHandling::SaveAscii, Mantid::DataHandling::SaveDaveGrp, Mantid::DataHandling::SNSAppendGeometryToNexus, Mantid::DataHandling::UpdateInstrumentFromFile, and Mantid::MDAlgorithms::TransposeMD.

Definition at line 170 of file Algorithm.h.

◆ aliasDeprecated()

const std::string Mantid::API::Algorithm::aliasDeprecated ( ) const

inlineoverridevirtual

Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date.

Implements Mantid::API::IAlgorithm.

Definition at line 175 of file Algorithm.h.

◆ asJson()

Json::Value Mantid::API::Algorithm::asJson ( bool withDefaultValues = false ) const

overridevirtual

Return the property manager serialized as a json object.

Parameters

withDefaultValues :: If true then the value of default parameters will be included

Returns: A jsonValue of the manager

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1992 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::asJson(), and m_properties.

◆ asString()

std::string Mantid::API::Algorithm::asString ( bool withDefaultValues = false ) const

overridevirtual

Return the property manager serialized as a string.

The format is propName=value,propName=value,propName=value

Parameters

withDefaultValues :: If true then the value of default parameters will be included

Returns: A stringized version of the manager

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1985 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::asString(), and m_properties.

◆ cacheInputWorkspaceHistories()

void Mantid::API::Algorithm::cacheInputWorkspaceHistories ( )

protected

Cache the histories of any input workspaces so they can be copied over after algorithm completion.

Definition at line 371 of file Algorithm.cpp.

References getProperties(), group, Mantid::Kernel::Direction::InOut, Mantid::Kernel::Direction::Input, m_inputWorkspaceHistories, and trackingHistory().

Referenced by executeInternal().

◆ cacheWorkspaceProperties()

void Mantid::API::Algorithm::cacheWorkspaceProperties ( )

protected

Go through the properties and cache the input/output workspace properties for later use.

Definition at line 339 of file Algorithm.cpp.

References getProperties(), Mantid::Kernel::Direction::InOut, Mantid::Kernel::Direction::Input, m_inputWorkspaceProps, m_outputWorkspaceProps, m_pureOutputWorkspaceProps, and Mantid::Kernel::Direction::Output.

Referenced by executeInternal().

◆ cancel()

void Mantid::API::Algorithm::cancel ( )

overridevirtual

Raises the cancel flag.

Cancel an algorithm.

Implements Mantid::API::IAlgorithm.

Reimplemented in Mantid::DataHandling::Load.

Definition at line 1662 of file Algorithm.cpp.

References m_cancel, and m_ChildAlgorithms.

Referenced by Mantid::ICat::CatalogDownloadDataFiles::doDownloadandSavetoLocalDrive(), and Mantid::ICat::CatalogPublish::publish().

◆ categories()

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

overridevirtual

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

Implements Mantid::API::IAlgorithm.

Definition at line 246 of file Algorithm.cpp.

References Mantid::Kernel::StringTokenizer::asVector(), category(), categorySeparator(), Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY, and Mantid::Kernel::StringTokenizer::TOK_TRIM.

◆ category()

const std::string Mantid::API::Algorithm::category ( ) const

inlineoverridevirtual

function to return a category of the algorithm.

A default implementation is provided

Implements Mantid::API::IAlgorithm.

Definition at line 160 of file Algorithm.h.

Referenced by categories().

◆ categorySeparator()

const std::string Mantid::API::Algorithm::categorySeparator ( ) const

inlineoverridevirtual

Function to return the separator token for the category string.

A default implementation ';' is provided

Implements Mantid::API::IAlgorithm.

Definition at line 165 of file Algorithm.h.

Referenced by categories().

◆ checkGroups()

bool Mantid::API::Algorithm::checkGroups ( )

virtual

Check the input workspace properties for groups.

If there are more than one input workspace properties, then:

All inputs should be groups of the same size
- In this case, algorithms are processed in order
OR, only one input should be a group, the others being size of 1

If the property itself is a WorkspaceProperty<WorkspaceGroup> then this returns false

Returns true if processGroups() should be called. It also sets up some other members.

Override if it is needed to customize the group checking.

Exceptions

std::invalid_argument	if the groups sizes are incompatible.
std::invalid_argument	if a member is not found

This method (or an override) must NOT THROW any exception if there are no input workspace groups

Reimplemented in Mantid::Algorithms::DeleteWorkspace, Mantid::Algorithms::DiscusMultipleScatteringCorrection, Mantid::Algorithms::HeliumAnalyserEfficiencyTime, Mantid::Algorithms::SassenaFFT, Mantid::Algorithms::Stitch1DMany, Mantid::API::MultiPeriodGroupAlgorithm, Mantid::DataHandling::SaveNXcanSAS, Mantid::DataHandling::SavePolarizedNXcanSAS, Mantid::DataHandling::SaveReflectometryAscii, Mantid::ICat::CatalogPublish, and Mantid::PythonInterface::RunPythonScript.

Definition at line 1172 of file Algorithm.cpp.

References Mantid::API::WorkspaceGroup::areNamesSimilar(), Mantid::API::WorkspaceProperty< TYPE >::getWorkspace(), m_groupsHaveSimilarNames, m_groupSize, m_groupWorkspaces, m_inputWorkspaceProps, m_singleGroup, and m_unrolledInputWorkspaces.

Referenced by Mantid::Algorithms::DeleteWorkspace::checkGroups(), Mantid::API::MultiPeriodGroupAlgorithm::checkGroups(), and executeInternal().

◆ clear()

void Mantid::API::Algorithm::clear ( )

overridevirtual

Clears all properties under management.

Implements Mantid::Kernel::IPropertyManager.

Definition at line 2015 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::clear(), and m_properties.

Referenced by Mantid::Algorithms::DetectorEfficiencyCor::DetectorEfficiencyCor(), Mantid::Algorithms::BinaryOperation::do2D(), Mantid::Algorithms::He3TubeEfficiency::He3TubeEfficiency(), and Mantid::CurveFitting::Algorithms::VesuvioCalculateGammaBackground::~VesuvioCalculateGammaBackground().

◆ clearWorkspaceCaches()

void Mantid::API::Algorithm::clearWorkspaceCaches ( )

private

Clear any internal workspace handles so that workspaces will be deleted promptly after a managed algorithm finishes.

Definition at line 507 of file Algorithm.cpp.

References m_groupWorkspaces, m_inputWorkspaceHistories, m_inputWorkspaceProps, m_outputWorkspaceProps, m_pureOutputWorkspaceProps, and m_unrolledInputWorkspaces.

Referenced by executeInternal().

◆ copyNonWorkspaceProperties()

void Mantid::API::Algorithm::copyNonWorkspaceProperties	(	IAlgorithm *	alg,
		int	periodNum
	)

Copy all the non-workspace properties from this to alg.

Parameters

alg	:: other IAlgorithm
periodNum	:: number of the "period" = the entry in the group + 1

Definition at line 1541 of file Algorithm.cpp.

References getProperties(), Mantid::API::IAlgorithm::name(), and setOtherProperties().

Referenced by processGroups(), and Mantid::API::MultiPeriodGroupWorker::processGroups().

◆ copyPropertiesFrom()

virtual void Mantid::API::Algorithm::copyPropertiesFrom ( const Algorithm & alg )

inlinevirtual

Make m_properties point to the same PropertyManager as alg.m_properties.

Definition at line 320 of file Algorithm.h.

References m_properties.

Referenced by Mantid::DataHandling::LoadMuonNexusV2::runLoadISISNexus().

◆ createChildAlgorithm()

Algorithm_sptr Mantid::API::Algorithm::createChildAlgorithm	(	const std::string &	name,
		const double	startProgress = `-1.`,
		const double	endProgress = `-1.`,
		const bool	enableLogging = `true`,
		const int &	version = `-1`
	)

virtual

Create a Child Algorithm.

A call to this method creates a child algorithm object. Using this mechanism instead of creating daughter algorithms directly via the new operator is prefered since then the framework can take care of all of the necessary book-keeping.

Parameters

name	:: The concrete algorithm class of the Child Algorithm
startProgress	:: The percentage progress value of the overall algorithm where this child algorithm starts
endProgress	:: The percentage progress value of the overall algorithm where this child algorithm ends
enableLogging	:: Set to false to disable logging from the child algorithm
version	:: The version of the child algorithm to create. By default gives the latest version.

Returns: shared pointer to the newly created algorithm object

Reimplemented in Mantid::API::NexusFileLoader.

Definition at line 860 of file Algorithm.cpp.

References name(), setupAsChildAlgorithm(), and version().

◆ declareOrReplaceProperty()

void Mantid::API::Algorithm::declareOrReplaceProperty	(	std::unique_ptr< Kernel::Property >	p,
		const std::string &	doc = `""`
	)

overridevirtual

Add or replace property in the list of managed properties.

Parameters

p	:: The property object to add
doc	:: A description of the property that may be displayed to users

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1811 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::declareOrReplaceProperty(), and m_properties.

Referenced by Mantid::DataHandling::Load::setOutputProperties().

◆ declareProperty() [1/8]

void Mantid::Kernel::IPropertyManager::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`
	)

inline

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).

The validator, if provided, needs to be a string validator.

Parameters

name	:: The name to assign to the property
value	:: The initial value to assign to the property
doc	:: The (optional) documentation string
validator	:: Pointer to the (optional) validator. Ownership will be taken over.
direction	:: The (optional) direction of the property, in, out or inout

Exceptions

Exception::ExistsError	if a property with the given name already exists
std::invalid_argument	if the name argument is empty
std::invalid_argument	if value is a nullptr

Definition at line 166 of file IPropertyManager.h.

◆ declareProperty() [2/8]

void Mantid::Kernel::IPropertyManager::declareProperty	(	const std::string &	name,
		const char *	value,
		const unsigned int	direction
	)

inline

Add a property of string type to the list of managed properties.

Parameters

name	:: The name to assign to the property
value	:: The initial value to assign to the property
direction	:: The direction of the property, in, out or inout

Exceptions

Exception::ExistsError	if a property with the given name already exists
std::invalid_argument	if the name argument is empty

Definition at line 183 of file IPropertyManager.h.

◆ declareProperty() [3/8]

void Mantid::Kernel::IPropertyManager::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`
	)

inline

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).

The validator, if provided, needs to be a string validator.

Parameters

name	:: The name to assign to the property
value	:: The initial value to assign to the property
validator	:: Pointer to the (optional) validator. Ownership will be taken over.
doc	:: The (optional) documentation string
direction	:: The (optional) direction of the property, in, out or inout

Exceptions

Exception::ExistsError	if a property with the given name already exists
std::invalid_argument	if the name argument is empty
std::invalid_argument	if value is a nullptr

Definition at line 137 of file IPropertyManager.h.

◆ declareProperty() [4/8]

template<typename T >

void Mantid::Kernel::IPropertyManager::declareProperty	(	const std::string &	name,
		T	value,
		const std::string &	doc,
		const unsigned int	direction = `Direction::Input`
	)

inline

Add a property to the list of managed properties with no validator.

Parameters

name	:: The name to assign to the property
value	:: The initial value to assign to the property
doc	:: The documentation string
direction	:: The (optional) direction of the property, in (default), out or inout

Exceptions

Exception::ExistsError	if a property with the given name already exists
std::invalid_argument	if the name argument is empty

Definition at line 98 of file IPropertyManager.h.

◆ declareProperty() [5/8]

template<typename T >

void Mantid::Kernel::IPropertyManager::declareProperty	(	const std::string &	name,
		T	value,
		const unsigned int	direction
	)

inline

Add a property of the template type to the list of managed properties.

Parameters

name	:: The name to assign to the property
value	:: The initial value to assign to the property
direction	:: The direction of the property, in, out or inout

Exceptions

Exception::ExistsError	if a property with the given name already exists
std::invalid_argument	if the name argument is empty

Definition at line 113 of file IPropertyManager.h.

◆ declareProperty() [6/8]

template<typename T >

void Mantid::Kernel::IPropertyManager::declareProperty	(	const std::string &	name,
		T	value,
		IValidator_sptr	validator = `std::make_shared<NullValidator>()`,
		const std::string &	doc = `""`,
		const unsigned int	direction = `Direction::Input`
	)

inline

Add a property of the template type to the list of managed properties.

Parameters

name	:: The name to assign to the property
value	:: The initial value to assign to the property
validator	:: Pointer to the (optional) validator.
doc	:: The (optional) documentation string
direction	:: The (optional) direction of the property, in, out or inout

Exceptions

Exception::ExistsError	if a property with the given name already exists
std::invalid_argument	if the name argument is empty

Definition at line 81 of file IPropertyManager.h.

◆ declareProperty() [7/8]

void Mantid::API::Algorithm::declareProperty	(	std::unique_ptr< Kernel::Property >	p,
		const std::string &	doc = `""`
	)

overridevirtual

Add a property to the list of managed properties.

Parameters

p	:: The property object to add
doc	:: A description of the property that may be displayed to users

Exceptions

Exception::ExistsError if a property with the given name already exists

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1803 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::declareProperty(), and m_properties.

◆ declareProperty() [8/8]

virtual void Mantid::Kernel::IPropertyManager::declareProperty	(	std::unique_ptr< Property >	p,
		const std::string &	doc = `""`
	)

virtual

Function to declare properties (i.e. store them)

Implements Mantid::Kernel::IPropertyManager.

◆ declareWorkspaceInputProperties()

template<typename T , const int AllowedIndexTypes, typename... WSPropArgs, typename >

void Mantid::API::Algorithm::declareWorkspaceInputProperties	(	const std::string &	propertyName,
		const std::string &	doc,
		WSPropArgs &&...	wsPropArgs
	)

protected

Declare a property which defines the workspace and allowed index types, as well as a property for capturing the indices all at once.

This method is only enabled if T is convertible to MatrixWorkspace. The AllowedIndexTypes combination of allowed index types. Default IndexType::WorkspaceIndex

Parameters

propertyName	Name of property which will be reserved
wsPropArgs	a parameter pack of arguments forwarded to WorkspaceProperty. Can contain PropertyMode, LockMode, and validators.
doc	Property documentation string.

Definition at line 42 of file Algorithm.hxx.

References declareProperty(), Mantid::API::IndexProperty::generatePropertyName(), Mantid::API::IndexTypeProperty::generatePropertyName(), Mantid::Kernel::Direction::Input, and m_reservedList.

◆ doCallProcessGroups()

bool Mantid::API::Algorithm::doCallProcessGroups ( Mantid::Types::Core::DateAndTime & startTime )

private

Calls process groups with the required timing checks and algorithm execution finalization steps.

Parameters

startTime to record the algorithm execution start

Returns: whether processGroups succeeds.

Definition at line 1265 of file Algorithm.cpp.

References Mantid::Kernel::Timer::elapsed(), Mantid::API::Failed, fillHistory(), findWorkspaces(), g_execCount, interruption_point(), isExecuted(), m_alwaysStoreInADS, m_history, m_runningAsync, m_usingBaseProcessGroups, notificationCenter(), Mantid::Kernel::Direction::Output, processGroups(), reportCompleted(), setResultState(), store(), Mantid::API::Success, and trackingHistory().

Referenced by executeInternal().

◆ doSetInputProperties()

template<typename T1 , typename T2 , typename WsType >

void Mantid::API::Algorithm::doSetInputProperties	(	const std::string &	name,
		const T1 &	wksp,
		IndexType	type,
		const T2 &	list
	)

private

Definition at line 71 of file Algorithm.hxx.

References Mantid::API::IndexProperty::generatePropertyName(), Mantid::API::IndexTypeProperty::generatePropertyName(), getPointerToProperty(), isCompoundProperty(), and name().

◆ enableHistoryRecordingForChild()

void Mantid::API::Algorithm::enableHistoryRecordingForChild ( const bool on )

overridevirtual

Change the state of the history recording flag.

Only applicable for child algorithms.

Parameters

on	:: The new state of the flag

Implements Mantid::API::IAlgorithm.

Definition at line 176 of file Algorithm.cpp.

References m_recordHistoryForChild.

Referenced by export_leaf_classes(), Mantid::Algorithms::Comment::init(), and trackAlgorithmHistory().

◆ exec()

virtual void Mantid::API::Algorithm::exec ( )

protectedpure virtual

Virtual method - must be overridden by concrete algorithm.

Referenced by Mantid::DataHandling::LoadEMUTar::exec(), Mantid::DataHandling::LoadEMUHdf::exec(), and executeInternal().

◆ execute()

bool Mantid::API::Algorithm::execute ( )

finaloverridevirtual

The actions to be performed by the algorithm on a dataset.

This method is invoked for top level algorithms by the application manager. This method invokes exec() method. For Child Algorithms either the execute() method or exec() method must be EXPLICITLY invoked by the parent algorithm.

Exceptions

runtime_error Thrown if algorithm or Child Algorithm cannot be executed

Returns: true if executed successfully.

Implements Mantid::API::IAlgorithm.

Definition at line 24 of file AlgorithmExecuteProfile.cpp.

References executeInternal(), and name().

Referenced by Mantid::DataHandling::LoadILLSANS::applySensitivityMap(), Mantid::MDAlgorithms::LoadGaussCube::exec(), executeAsChildAlg(), executeAsyncImpl(), processGroups(), and SANSInstrumentCreationHelper::runLoadInstrument().

◆ executeAsChildAlg()

void Mantid::API::Algorithm::executeAsChildAlg ( )

overridevirtual

Execute as a Child Algorithm.

This runs execute() but catches errors so as to log the name of the failed Child Algorithm, if it fails.

Implements Mantid::API::IAlgorithm.

Definition at line 787 of file Algorithm.cpp.

References execute(), and name().

Referenced by Mantid::Crystal::GoniometerAnglesFromPhiRotation::exec().

◆ executeAsync()

Poco::ActiveResult< bool > Mantid::API::Algorithm::executeAsync ( )

overridevirtual

Asynchronous execution.

Implements Mantid::API::IAlgorithm.

Definition at line 1613 of file Algorithm.cpp.

References executeAsyncImpl(), and m_executeAsync.

◆ executeAsyncImpl()

bool Mantid::API::Algorithm::executeAsyncImpl ( const Poco::Void & i )

private

Callback when an algorithm is executed asynchronously.

Parameters

i	:: Unused argument

Returns: true if executed successfully.

Definition at line 1623 of file Algorithm.cpp.

References execute(), and m_runningAsync.

Referenced by executeAsync().

◆ executeInternal()

bool Mantid::API::Algorithm::executeInternal ( )

private

Invoced internally in execute()

Definition at line 520 of file Algorithm.cpp.

References cacheInputWorkspaceHistories(), cacheWorkspaceProperties(), calledByAlias, checkGroups(), clearWorkspaceCaches(), Mantid::Kernel::Logger::debug(), doCallProcessGroups(), Mantid::Kernel::Timer::elapsed(), error, Mantid::Kernel::Logger::error(), exec(), existsProperty(), Mantid::API::Failed, fillHistory(), g_execCount, getAlgorithmID(), getLogger(), getProperties(), interruption_point(), isExecuted(), isInitialized(), linkHistoryWithLastChild(), lockWorkspaces(), logAlgorithmInfo(), m_alwaysStoreInADS, m_gcTime, m_history, m_isChildAlgorithm, m_rethrow, m_runningAsync, name(), notificationCenter(), registerFeatureUsage(), reportCompleted(), Mantid::API::Running, setExecutionState(), setResultState(), store(), Mantid::API::Success, std::to_string(), trackingHistory(), unlockWorkspaces(), validateInputs(), validateProperties(), and Mantid::Kernel::Logger::warning().

Referenced by execute().

◆ executionState()

ExecutionState Mantid::API::Algorithm::executionState ( ) const

overridevirtual

Gets the current execution state.

Implements Mantid::API::IAlgorithm.

Definition at line 129 of file Algorithm.cpp.

References m_executionState.

Referenced by isExecuted(), isReadyForGarbageCollection(), and isRunning().

◆ existsProperty()

bool Mantid::API::Algorithm::existsProperty ( const std::string & name ) const

overridevirtual

Checks whether the named property is already in the list of managed property.

Parameters

name	:: The name of the property (case insensitive)

Returns: True if the property is already stored

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1898 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::existsProperty(), m_properties, and name().

Referenced by Mantid::Algorithms::FilterEvents::createOutputWorkspaces(), executeInternal(), Mantid::Algorithms::SpectrumAlgorithm::getWorkspaceIndexSet(), Mantid::Algorithms::FilterEvents::groupOutputWorkspace(), Mantid::CurveFitting::Algorithms::Fit::initializeMinimizer(), Mantid::DataHandling::Load::loadFileToWs(), Mantid::DataHandling::LoadEventNexus::loadInstrument(), Mantid::DataHandling::Load::loadSingleFile(), Mantid::CurveFitting::Functions::UserFunction1D::prepare(), Mantid::CurveFitting::IFittingAlgorithm::setFunction(), Mantid::DataHandling::LoadNexus::setOutputWorkspace(), Mantid::Algorithms::FindCenterOfMassPosition2::storeOutputWorkspace(), and Mantid::Algorithms::Rebin::validateInputs().

◆ fillHistory() [1/2]

void Mantid::API::Algorithm::fillHistory ( )

protectedvirtual

Copy workspace history from input workspaces to output workspaces and record the history for ths algorithm.

Fills History, Algorithm History and Algorithm Parameters.

Reimplemented in Mantid::Algorithms::ConjoinXRuns, and Mantid::Algorithms::MergeRuns.

Definition at line 1012 of file Algorithm.cpp.

References fillHistory(), findWorkspaces(), isChild(), and Mantid::Kernel::Direction::Output.

Referenced by doCallProcessGroups(), Mantid::Algorithms::UnGroupWorkspace::exec(), executeInternal(), and fillHistory().

◆ fillHistory() [2/2]

void Mantid::API::Algorithm::fillHistory ( const std::vector< Workspace_sptr > & outputWorkspaces )

protected

Copy workspace history from input workspaces to provided vector of output workspaces.

If this algorithm is not a child then copy history between the inputs and outputs and add a record for this algorithm.

If the algorithm is a child attach the child history to the parent if requested.

Parameters

outputWorkspaces :: A reference to a vector for the output workspaces. Used in the non-child case.

Definition at line 1333 of file Algorithm.cpp.

References Mantid::API::Workspace::getHistory(), isChild(), m_history, m_inputWorkspaceHistories, m_parentHistory, and m_recordHistoryForChild.

◆ findWorkspaces()

void Mantid::API::Algorithm::findWorkspaces	(	WorkspaceVector &	workspaces,
		unsigned int	direction,
		bool	checkADS = `false`
	)		const

Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output)

Parameters

workspaces	A reference to a vector for the workspaces
direction	The direction of the property required for the search
checkADS	If true, check the ADS for workspace references if the check on the workspace property value is empty. Most useful for finding group workspaces that are never stored on the property

Definition at line 1091 of file Algorithm.cpp.

References getProperties(), Mantid::API::IWorkspaceProperty::getWorkspace(), Mantid::Kernel::Direction::InOut, and workspace.

Referenced by doCallProcessGroups(), fillHistory(), and Mantid::API::MultiPeriodGroupWorker::findMultiPeriodGroups().

◆ fromHistory()

IAlgorithm_sptr Mantid::API::Algorithm::fromHistory ( const AlgorithmHistory & history )

static

Construct an object from a history entry.

This creates the algorithm and sets all of its properties using the history.

Parameters

history :: AlgorithmHistory object

Returns: a shared pointer to the created algorithm.

Definition at line 947 of file Algorithm.cpp.

References fromString(), and history.

Referenced by Mantid::API::AlgorithmHistory::createAlgorithm(), Mantid::API::WorkspaceHistory::getAlgorithm(), and Mantid::API::AlgorithmHistory::getChildAlgorithm().

◆ fromJson()

IAlgorithm_sptr Mantid::API::Algorithm::fromJson ( const Json::Value & serialized )

static

De-serialize an object from a Json.

De-serializes the algorithm from a Json object.

Parameters

serialized A reference to Json::Value that contains a serialized algorithm object

Returns: A new algorithm object

Exceptions

std::runtime_error if the algorithm cannot be created

Definition at line 1001 of file Algorithm.cpp.

Referenced by fromString(), and Mantid::API::AlgorithmProperty::setValueFromJson().

◆ fromString()

IAlgorithm_sptr Mantid::API::Algorithm::fromString ( const std::string & input )

static

De-serialize an object from a string.

De-serializes the algorithm from a string.

Parameters

input :: An input string in the format. The format is AlgorithmName.version(prop1=value1,prop2=value2,...). If .version is not found the highest found is used.

Returns: A pointer to a managed algorithm object

Exceptions

std::runtime_error if the algorithm cannot be created

Definition at line 985 of file Algorithm.cpp.

References fromJson().

Referenced by Mantid::WorkflowAlgorithms::EQSANSDarkCurrentSubtraction::exec(), Mantid::WorkflowAlgorithms::EQSANSDarkCurrentSubtraction2::exec(), Mantid::WorkflowAlgorithms::HFIRDarkCurrentSubtraction::exec(), Mantid::WorkflowAlgorithms::SANSSensitivityCorrection::exec(), export_leaf_classes(), fromHistory(), Mantid::WorkflowAlgorithms::SANSBeamFinder::loadBeamFinderFile(), and Mantid::API::AlgorithmProperty::setValue().

◆ getAlgorithmID()

AlgorithmID Mantid::API::Algorithm::getAlgorithmID ( ) const

inlineoverridevirtual

Algorithm ID.

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

Implements Mantid::API::IAlgorithm.

Definition at line 204 of file Algorithm.h.

Referenced by executeInternal().

◆ getAlgStartupLogging()

bool Mantid::API::Algorithm::getAlgStartupLogging ( ) const

overridevirtual

get the state of Logging of start and end messages

return the state of logging of start and end messages

Returns: : true to logging is enabled

Implements Mantid::API::IAlgorithm.

Definition at line 1761 of file Algorithm.cpp.

References m_isAlgStartupLoggingEnabled.

◆ getAlwaysStoreInADS()

bool Mantid::API::Algorithm::getAlwaysStoreInADS ( ) const

overridevirtual

Returns true if we always store in the AnalysisDataService.

Returns: true if output is saved to the AnalysisDataService.

Implements Mantid::API::IAlgorithm.

Definition at line 197 of file Algorithm.cpp.

References m_alwaysStoreInADS.

Referenced by Mantid::Algorithms::DiscusMultipleScatteringCorrection::exec(), and Mantid::API::AlgorithmHistory::fillAlgorithmHistory().

◆ getCancel()

bool Mantid::API::Algorithm::getCancel ( ) const

Returns the cancellation state.

Definition at line 1675 of file Algorithm.cpp.

References m_cancel.

Referenced by Mantid::API::Progress::hasCancellationBeenRequested(), Mantid::DataHandling::LoadDNSEvent::populate_EventWorkspace(), Mantid::DataHandling::LoadNGEM::reportProgressAndCheckCancel(), Mantid::DataHandling::LoadBankFromDiskTask::run(), and Mantid::DataHandling::ProcessBankData::run().

◆ getDeclaredPropertyNames()

std::vector< std::string > Mantid::API::Algorithm::getDeclaredPropertyNames ( ) const

overridevirtualnoexcept

Return the list of declared property names.

Returns: A vector holding strings of property names

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1946 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getDeclaredPropertyNames(), and m_properties.

◆ getLogger()

Kernel::Logger & Mantid::API::Algorithm::getLogger ( ) const

Returns a reference to the logger.

Definition at line 1678 of file Algorithm.cpp.

References g_log.

◆ getLoggingOffset()

int Mantid::API::Algorithm::getLoggingOffset ( ) const

overridevirtual

returns the logging priority offset

Implements Mantid::API::IAlgorithm.

Definition at line 1692 of file Algorithm.cpp.

References g_log, and Mantid::Kernel::Logger::getLevelOffset().

◆ getPointerToProperty()

Property * Mantid::API::Algorithm::getPointerToProperty ( const std::string & name ) const

overridevirtual

Get a property by name.

Parameters

name	:: The name of the property (case insensitive)

Returns: A pointer to the named property

Exceptions

Exception::NotFoundError if the named property is unknown

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1923 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getPointerToProperty(), m_properties, and name().

Referenced by Mantid::CurveFitting::IFittingAlgorithm::afterPropertySet(), Mantid::API::checkForMandatoryInstrumentDefault(), Mantid::API::checkForOptionalInstrumentDefault(), Mantid::Algorithms::ExponentialCorrection::defineProperties(), doSetInputProperties(), Mantid::Algorithms::CalculateFlatBackground::exec(), Mantid::Algorithms::ExtractSpectra2::exec(), Mantid::Algorithms::NormaliseToMonitor::exec(), Mantid::CurveFitting::Algorithms::PawleyFit::exec(), Mantid::MDAlgorithms::IntegrateEllipsoidsV2::exec(), Mantid::MDAlgorithms::LoadDNSSCD::exec(), Mantid::MDAlgorithms::MergeMDFiles::exec(), Mantid::MDAlgorithms::PreprocessDetectorsToMD::exec(), Mantid::CurveFitting::Algorithms::EstimateFitParameters::execConcrete(), getWorkspaceAndIndices(), Mantid::DataHandling::SaveAscii::init(), Mantid::DataHandling::SaveAscii2::init(), Mantid::DataHandling::SaveCSV::init(), Mantid::MDAlgorithms::ConvertToMDParent::init(), Mantid::CurveFitting::Algorithms::DoublePulseFit::initConcrete(), Mantid::CurveFitting::Algorithms::Fit::initConcrete(), Mantid::CurveFitting::Algorithms::QENSFitSimultaneous::initConcrete(), Mantid::DataHandling::LoadILLDiffraction::loadDataScan(), Mantid::DataHandling::LoadILLSANS::loadMetaData(), Mantid::Algorithms::Bin2DPowderDiffraction::validateInputs(), Mantid::Algorithms::DiffractionFocussing2::validateInputs(), Mantid::Crystal::ConvertPeaksWorkspace::validateInputs(), Mantid::Crystal::FindSXPeaks::validateInputs(), Mantid::MDAlgorithms::IntegrateEllipsoidsV2::validateInputs(), and Mantid::Algorithms::MergeLogs::validateTSP().

◆ getPointerToPropertyOrdinal()

Property * Mantid::API::Algorithm::getPointerToPropertyOrdinal ( const int & index ) const

overridevirtual

Get a property by an index.

Parameters

index :: The name of the property (case insensitive)

Returns: A pointer to the named property

Exceptions

std::runtime_error if the property index is too high

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1932 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getPointerToPropertyOrdinal(), index, and m_properties.

◆ getProperties()

const std::vector< Property * > & Mantid::API::Algorithm::getProperties ( ) const

overridevirtual

Get the list of managed properties.

The properties will be stored in the order that they were declared.

Returns: A vector holding pointers to the list of properties

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1940 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getProperties(), and m_properties.

Referenced by Mantid::CurveFitting::IFittingAlgorithm::addWorkspaces(), Mantid::MDAlgorithms::MDNormDirectSC::binInputWS(), Mantid::MDAlgorithms::MDNormSCD::binInputWS(), cacheInputWorkspaceHistories(), cacheWorkspaceProperties(), copyNonWorkspaceProperties(), Mantid::DataHandling::Load::declareLoaderProperties(), Mantid::MDAlgorithms::UnaryOperationMD::exec(), executeInternal(), findWorkspaces(), Mantid::CurveFitting::Algorithms::Fit1D::init(), Mantid::DataHandling::Load::init(), linkHistoryWithLastChild(), Mantid::DataHandling::Load::loadFileToWs(), Mantid::Algorithms::CompareWorkspaces::processGroups(), Mantid::API::AlgorithmHistory::setProperties(), and store().

◆ getProperty()

IPropertyManager::TypedValue Mantid::API::Algorithm::getProperty ( const std::string & name ) const

overridevirtual

Get the value of a property.

Allows you to assign directly to a variable of the property's type (if a supported type).

*** This method does NOT work for assigning to an existing std::string. In this case you have to use getPropertyValue() instead. Note that you can, though, construct a local string variable by writing, e.g. std::string s = getProperty("myProperty"). ***

Parameters

name	:: The name of the property

Returns: The value of the property. Will be cast to the desired type (if a supported type).

Exceptions

std::runtime_error	If an attempt is made to assign a property to a different type
Exception::NotFoundError	If the property requested does not exist

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1966 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getProperty(), m_properties, and name().

◆ getPropertyValue()

std::string Mantid::API::Algorithm::getPropertyValue ( const std::string & name ) const

overridevirtual

Get the value of a property as a string.

Parameters

name	:: The name of the property (case insensitive)

Returns: The value of the named property

Exceptions

Exception::NotFoundError if the named property is unknown

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1916 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getPropertyValue(), m_properties, and name().

◆ getWorkspaceAndIndices()

template<typename T , typename >

std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet > Mantid::API::Algorithm::getWorkspaceAndIndices ( const std::string & name ) const

Mechanism for retriving the index property.

This method can only be used if T is convertible to a MatrixWorkspace.

Parameters

name	Property name

Returns: Tuple containing Workspace shared pointer and SpectrumIndexSet

Definition at line 127 of file Algorithm.hxx.

References Mantid::API::IndexProperty::generatePropertyName(), getPointerToProperty(), getProperty(), isCompoundProperty(), and name().

◆ handleChildProgressNotification()

void Mantid::API::Algorithm::handleChildProgressNotification ( const Poco::AutoPtr< ProgressNotification > & pNf )

protected

Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm.

Handles and rescales child algorithm progress notifications.

Parameters

pNf	:: The progress notification from the child algorithm.

Definition at line 1641 of file Algorithm.cpp.

References m_endChildProgress, m_startChildProgress, and progress().

Referenced by progressObserver().

◆ helpURL()

const std::string Mantid::API::Algorithm::helpURL ( ) const

inlineoverridevirtual

function to return URL for algorithm documentation; A default implementation is provided.

Override if the algorithm is not part of the Mantid distribution.

Implements Mantid::API::IAlgorithm.

Definition at line 180 of file Algorithm.h.

◆ init()

virtual void Mantid::API::Algorithm::init ( )

protectedpure virtual

Virtual method - must be overridden by concrete algorithm.

Referenced by Mantid::DataHandling::LoadEMUTar::init(), Mantid::DataHandling::LoadEMUHdf::init(), and initialize().

◆ initialize()

void Mantid::API::Algorithm::initialize ( )

overridevirtual

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.

Exceptions

runtime_error Thrown if algorithm or Child Algorithm cannot be initialised

Implements Mantid::API::IAlgorithm.

Definition at line 292 of file Algorithm.cpp.

References Mantid::Kernel::Logger::fatal(), g_log, getLogger(), init(), Mantid::API::Initialized, isInitialized(), name(), setExecutionState(), setLoggingOffset(), and Mantid::Kernel::Logger::setName().

Referenced by Mantid::DataHandling::LoadILLSANS::applySensitivityMap(), Mantid::Crystal::GoniometerAnglesFromPhiRotation::exec(), Mantid::MDAlgorithms::LoadGaussCube::exec(), and SANSInstrumentCreationHelper::runLoadInstrument().

◆ interruption_point()

void Mantid::API::Algorithm::interruption_point ( )

protected

This is called during long-running operations, and check if the algorithm has requested that it be cancelled.

Definition at line 1698 of file Algorithm.cpp.

References IF_NOT_PARALLEL, and m_cancel.

◆ isChild()

bool Mantid::API::Algorithm::isChild ( ) const

overridevirtual

To query whether algorithm is a child.

Returns: true - the algorithm is a child algorithm. False - this is a full managed algorithm.

Implements Mantid::API::IAlgorithm.

Definition at line 160 of file Algorithm.cpp.

References m_isChildAlgorithm.

Referenced by Mantid::DataHandling::SaveNexusProcessed::doExec(), Mantid::Algorithms::Stitch1DMany::doStitch1D(), fillHistory(), Mantid::Algorithms::ConjoinXRuns::fillHistory(), fillHistory(), Mantid::CurveFitting::Algorithms::Fit::finalizeMinimizer(), lockWorkspaces(), logAlgorithmInfo(), Mantid::CurveFitting::Algorithms::Fit::readProperties(), registerFeatureUsage(), reportCompleted(), Mantid::DataHandling::SaveNexus::runSaveNexusProcessed(), setChild(), Mantid::Algorithms::PolarizationEfficienciesWildes::setOutputs(), trackingHistory(), and unlockWorkspaces().

◆ isCompoundProperty()

bool Mantid::API::Algorithm::isCompoundProperty ( const std::string & name ) const

private

Definition at line 1763 of file Algorithm.cpp.

References m_reservedList, and name().

Referenced by doSetInputProperties(), and getWorkspaceAndIndices().

◆ isDefault()

bool Mantid::API::Algorithm::isDefault ( const std::string & name ) const

Parameters

name

Returns: True if the property is its default value.

Definition at line 1974 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::getPointerToProperty(), Mantid::Kernel::Property::isDefault(), m_properties, and name().

◆ isEmpty()

template<typename NumT >

static bool Mantid::API::Algorithm::isEmpty ( const NumT toCheck )

staticprotected

checks that the value was not set by users, uses the value in empty double/int.

◆ isExecuted()

bool Mantid::API::Algorithm::isExecuted ( ) const

overridevirtual

Has the Algorithm already been executed successfully.

Implements Mantid::API::IAlgorithm.

Definition at line 151 of file Algorithm.cpp.

References executionState(), Mantid::API::Finished, resultState(), and Mantid::API::Success.

Referenced by doCallProcessGroups(), and executeInternal().

◆ isInitialized()

bool Mantid::API::Algorithm::isInitialized ( ) const

overridevirtual

Has the Algorithm already been initialized.

Implements Mantid::API::IAlgorithm.

Definition at line 148 of file Algorithm.cpp.

References m_executionState, and Mantid::API::Uninitialized.

Referenced by executeInternal(), Mantid::API::MultiPeriodGroupWorker::findMultiPeriodGroups(), and initialize().

◆ isLogging()

bool Mantid::API::Algorithm::isLogging ( ) const

overridevirtual

returns the status of logging, True = enabled

Implements Mantid::API::IAlgorithm.

Definition at line 1682 of file Algorithm.cpp.

References g_log, and Mantid::Kernel::Logger::getEnabled().

Referenced by Mantid::DataHandling::SaveMask::exec(), processGroups(), and Mantid::API::MultiPeriodGroupWorker::processGroups().

◆ isReadyForGarbageCollection()

bool Mantid::API::Algorithm::isReadyForGarbageCollection ( ) const

overridevirtual

True if the algorithm is ready for garbage collection.

Implements Mantid::API::IAlgorithm.

Definition at line 208 of file Algorithm.cpp.

References executionState(), Mantid::API::Finished, and m_gcTime.

◆ isRecordingHistoryForChild()

bool Mantid::API::Algorithm::isRecordingHistoryForChild ( )

inline

Definition at line 225 of file Algorithm.h.

Referenced by Mantid::DataHandling::SaveNexusProcessed::doExec(), Mantid::Algorithms::ConjoinXRuns::fillHistory(), and Mantid::DataHandling::SaveNexus::runSaveNexusProcessed().

◆ isRunning()

bool Mantid::API::Algorithm::isRunning ( ) const

overridevirtual

True if the algorithm is running.

Implements Mantid::API::IAlgorithm.

Definition at line 205 of file Algorithm.cpp.

References executionState(), and Mantid::API::Running.

◆ isWorkspaceProperty()

bool Mantid::API::Algorithm::isWorkspaceProperty ( const Kernel::Property *const prop ) const

protected

checks the property is a workspace property

To query the property is a workspace property.

Parameters

prop	:: pointer to input properties

Returns: true if this is a workspace property

Definition at line 1577 of file Algorithm.cpp.

◆ linkHistoryWithLastChild()

void Mantid::API::Algorithm::linkHistoryWithLastChild ( )

private

Link the name of the output workspaces on this parent algorithm.

with the last child algorithm executed to ensure they match in the history.

This solves the case where child algorithms use a temporary name and this name needs to match the output name of the parent algorithm so the history can be re-run.

Definition at line 1028 of file Algorithm.cpp.

References getProperties(), Mantid::API::IWorkspaceProperty::getWorkspace(), Mantid::Kernel::Direction::InOut, m_history, m_recordHistoryForChild, Mantid::Kernel::Direction::Output, and workspace.

Referenced by executeInternal().

◆ lockWorkspaces()

void Mantid::API::Algorithm::lockWorkspaces ( )

private

Go through the workspace properties of this algorithm and lock the workspaces for reading or writing.

Definition at line 433 of file Algorithm.cpp.

References Mantid::Kernel::Logger::debug(), g_log, isChild(), m_inputWorkspaceProps, m_outputWorkspaceProps, m_readLockedWorkspaces, and m_writeLockedWorkspaces.

Referenced by executeInternal().

◆ logAlgorithmInfo()

void Mantid::API::Algorithm::logAlgorithmInfo ( ) const

private

Sends out algorithm parameter information to the logger.

Definition at line 1126 of file Algorithm.cpp.

References getLogger(), isChild(), m_isAlgStartupLoggingEnabled, name(), and Mantid::API::AlgorithmHistory::printSelf().

Referenced by executeInternal().

◆ name()

const std::string Mantid::API::Algorithm::name ( ) const

overridepure virtual

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

Implements Mantid::API::IAlgorithm.

Referenced by addTimer(), Mantid::CurveFitting::IFittingAlgorithm::addWorkspace(), afterPropertySet(), createChildAlgorithm(), Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::MDAlgorithms::SlicingAlgorithm::createTransform(), Mantid::Algorithms::BinaryOperation::do2D(), doSetInputProperties(), Mantid::Algorithms::BinaryOperation::doSingleColumn(), Mantid::Algorithms::BinaryOperation::doSingleSpectrum(), Mantid::Algorithms::BinaryOperation::doSingleValue(), Mantid::Algorithms::BinaryOperation::exec(), Mantid::Algorithms::RebinByTimeBase::exec(), execute(), executeAsChildAlg(), executeInternal(), existsProperty(), Mantid::API::AlgorithmHistory::fillAlgorithmHistory(), Mantid::CurveFitting::IFittingAlgorithm::getCostFunctionNames(), getPointerToProperty(), getProperty(), getPropertyValue(), getWorkspaceAndIndices(), Mantid::Algorithms::BinaryOperation::handleSpecialDivideMinus(), initialize(), isCompoundProperty(), isDefault(), logAlgorithmInfo(), Mantid::MDAlgorithms::SlicingAlgorithm::makeAlignedDimensionFromString(), Mantid::MDAlgorithms::SlicingAlgorithm::makeBasisVectorFromString(), processGroups(), Mantid::API::MultiPeriodGroupWorker::processGroups(), registerFeatureUsage(), removeProperty(), reportCompleted(), setPropertyValue(), setPropertyValueFromJson(), setWorkspaceInputProperties(), setWorkspaceInputProperties(), and toJson().

◆ notificationCenter()

Poco::NotificationCenter & Mantid::API::Algorithm::notificationCenter ( ) const

protected

Return a reference to the algorithm's notification dispatcher.

Returns: A reference to the Poco::NotificationCenter object that dispatches notifications

Definition at line 1632 of file Algorithm.cpp.

References m_notificationCenter.

Referenced by addObserver(), doCallProcessGroups(), executeInternal(), progress(), and removeObserver().

◆ operator=()

Algorithm & Mantid::API::Algorithm::operator= ( const Algorithm & )

delete

◆ processGroups()

bool Mantid::API::Algorithm::processGroups ( )

virtual

Process WorkspaceGroup inputs.

This should be called after checkGroups(), which sets up required members. It goes through each member of the group(s), creates and sets an algorithm for each and executes them one by one.

If there are several group input workspaces, then the member of each group is executed pair-wise.

Returns: true - if all the workspace members are executed.

Reimplemented in Mantid::Algorithms::CalculateEfficiency2, Mantid::Algorithms::CompareWorkspaces, Mantid::Algorithms::ConjoinWorkspaces, Mantid::Algorithms::RenameWorkspace, Mantid::Algorithms::SassenaFFT, Mantid::API::MultiPeriodGroupAlgorithm, Mantid::DataHandling::SaveNexus, Mantid::DataHandling::SaveNexusESS, Mantid::DataHandling::SaveNexusProcessed, Mantid::DataHandling::SaveNXcanSAS, Mantid::DataHandling::SaveNXTomo, and Mantid::DataHandling::SaveReflectometryAscii.

Definition at line 1383 of file Algorithm.cpp.

References copyNonWorkspaceProperties(), createChildAlgorithm(), execute(), isLogging(), m_groupsHaveSimilarNames, m_groupSize, m_inputWorkspaceProps, m_pureOutputWorkspaceProps, m_singleGroup, m_unrolledInputWorkspaces, m_usingBaseProcessGroups, name(), Mantid::Kernel::IPropertyManager::setProperty(), setPropertyValue(), Mantid::Kernel::Strings::toString(), and version().

Referenced by doCallProcessGroups(), Mantid::Algorithms::ConjoinWorkspaces::processGroups(), and Mantid::API::MultiPeriodGroupAlgorithm::processGroups().

◆ progress()

void Mantid::API::Algorithm::progress	(	double	p,
		const std::string &	msg = `""`,
		double	estimatedTime = `0.0`,
		int	progressPrecision = `0`
	)

protected

Sends ProgressNotification.

Parameters

p	:: Reported progress, must be between 0 (just started) and 1 (finished)
msg	:: Optional message string
estimatedTime	:: Optional estimated time to completion
progressPrecision	:: optional, int number of digits after the decimal point to show.

Definition at line 240 of file Algorithm.cpp.

References notificationCenter().

◆ progressObserver()

const Poco::AbstractObserver & Mantid::API::Algorithm::progressObserver ( ) const

protected

Return a reference to the algorithm's object that is reporting progress.

Returns: A Poco:NObserver object that is responsible for reporting progress

Definition at line 1650 of file Algorithm.cpp.

References handleChildProgressNotification(), and m_progressObserver.

Referenced by Mantid::DataHandling::LoadRawHelper::runLoadInstrument(), Mantid::DataHandling::LoadRawHelper::runLoadLog(), setupAsChildAlgorithm(), and Mantid::DataHandling::Load::setUpLoader().

◆ propertyCount()

size_t Mantid::API::Algorithm::propertyCount ( ) const

overridevirtual

Count the number of properties under management.

Returns: The number of properties being managed

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1909 of file Algorithm.cpp.

References m_properties, and Mantid::Kernel::PropertyManagerOwner::propertyCount().

Referenced by Mantid::DataHandling::Load::init().

◆ registerFeatureUsage()

void Mantid::API::Algorithm::registerFeatureUsage ( ) const

private

Registers the usage of the algorithm with the UsageService.

Definition at line 1745 of file Algorithm.cpp.

References isChild(), name(), and version().

Referenced by executeInternal().

◆ removeObserver()

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

overridevirtual

Remove an observer.

Parameters

observer :: Reference to the observer to remove

Implements Mantid::API::IAlgorithm.

Definition at line 227 of file Algorithm.cpp.

References notificationCenter().

◆ removeProperty()

void Mantid::API::Algorithm::removeProperty	(	const std::string &	name,
		const bool	delproperty = `true`
	)

overridevirtual

Removes the property from management.

Removes the property from properties map.

Parameters

name	:: Name of the property to be removed.
delproperty	:: if true, delete the named property

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1999 of file Algorithm.cpp.

References m_properties, name(), and Mantid::Kernel::PropertyManagerOwner::removeProperty().

Referenced by Mantid::DataHandling::Load::declareLoaderProperties(), Mantid::DataHandling::GenerateGroupingPowder2::init(), Mantid::MDAlgorithms::IntegrateEllipsoidsV2::init(), and Mantid::MDAlgorithms::IntegrateEllipsoidsV2::initInstance().

◆ reportCompleted()

void Mantid::API::Algorithm::reportCompleted	(	const double &	duration,
		const bool	groupProcessing = `false`
	)

private

Report that the algorithm has completed.

Parameters

duration	: Algorithm duration
groupProcessing	: We have been processing via processGroups if true.

Definition at line 1715 of file Algorithm.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Finished, getLogger(), isChild(), m_alwaysStoreInADS, m_isAlgStartupLoggingEnabled, m_isChildAlgorithm, name(), Mantid::Kernel::Logger::notice(), and setExecutionState().

Referenced by doCallProcessGroups(), and executeInternal().

◆ resetProperties()

void Mantid::API::Algorithm::resetProperties ( )

overridevirtual

Reset property values back to initial values (blank or default values)

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1817 of file Algorithm.cpp.

References m_properties, and Mantid::Kernel::PropertyManagerOwner::resetProperties().

◆ resultState()

ResultState Mantid::API::Algorithm::resultState ( ) const

overridevirtual

Gets the current result State.

Implements Mantid::API::IAlgorithm.

Definition at line 135 of file Algorithm.cpp.

References m_resultState.

Referenced by isExecuted().

◆ seeAlso()

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

inlineoverridevirtual

Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

Implements Mantid::API::IAlgorithm.

Definition at line 168 of file Algorithm.h.

◆ setAlgStartupLogging()

void Mantid::API::Algorithm::setAlgStartupLogging ( const bool enabled )

overridevirtual

disable Logging of start and end messages

Enable or disable Logging of start and end messages.

Parameters

enabled : true to enable logging, false to disable

Implements Mantid::API::IAlgorithm.

Definition at line 1756 of file Algorithm.cpp.

References m_isAlgStartupLoggingEnabled.

◆ setAlwaysStoreInADS()

void Mantid::API::Algorithm::setAlwaysStoreInADS ( const bool doStore )

overridevirtual

Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms.

Parameters

doStore :: always store in ADS

Implements Mantid::API::IAlgorithm.

Definition at line 183 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::existsProperty(), Mantid::Kernel::PropertyManagerOwner::getPointerToProperty(), m_alwaysStoreInADS, m_properties, Mantid::API::PropertyMode::Optional, and Mantid::API::setPropertyModeForWorkspaceProperty().

Referenced by setChild().

◆ setChild()

void Mantid::API::Algorithm::setChild ( const bool isChild )

overridevirtual

To set whether algorithm is a child.

Parameters

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

Implements Mantid::API::IAlgorithm.

Definition at line 166 of file Algorithm.cpp.

References isChild(), m_isChildAlgorithm, and setAlwaysStoreInADS().

Referenced by Mantid::Algorithms::FindPeaks::callFitPeak().

◆ setChildEndProgress()

void Mantid::API::Algorithm::setChildEndProgress ( const double endProgress ) const

inlineoverridevirtual

setting the child end progress

Implements Mantid::API::IAlgorithm.

Definition at line 256 of file Algorithm.h.

Referenced by Mantid::DataHandling::LoadRawHelper::runLoadInstrument(), Mantid::DataHandling::LoadRawHelper::runLoadLog(), and Mantid::DataHandling::Load::setUpLoader().

◆ setChildStartProgress()

void Mantid::API::Algorithm::setChildStartProgress ( const double startProgress ) const

inlineoverridevirtual

setting the child start progress

Implements Mantid::API::IAlgorithm.

Definition at line 254 of file Algorithm.h.

Referenced by Mantid::DataHandling::LoadRawHelper::runLoadInstrument(), Mantid::DataHandling::LoadRawHelper::runLoadLog(), and Mantid::DataHandling::Load::setUpLoader().

◆ setExecutionState()

void Mantid::API::Algorithm::setExecutionState ( const ExecutionState state )

protected

Sets the current execution state.

Definition at line 132 of file Algorithm.cpp.

References m_executionState.

Referenced by executeInternal(), initialize(), reportCompleted(), and setResultState().

◆ setLogging()

void Mantid::API::Algorithm::setLogging ( const bool value )

overridevirtual

Logging can be disabled by passing a value of false.

Implements Mantid::API::IAlgorithm.

Definition at line 1680 of file Algorithm.cpp.

References g_log, Mantid::Kernel::Logger::setEnabled(), and value.

◆ setLoggingOffset()

void Mantid::API::Algorithm::setLoggingOffset ( const int value )

overridevirtual

gets the logging priority offset

Implements Mantid::API::IAlgorithm.

Definition at line 1689 of file Algorithm.cpp.

References g_log, Mantid::Kernel::Logger::setLevelOffset(), and value.

Referenced by initialize().

◆ setOtherProperties()

void Mantid::API::Algorithm::setOtherProperties	(	IAlgorithm *	alg,
		const std::string &	propertyName,
		const std::string &	propertyValue,
		int	periodNum
	)

protectedvirtual

Virtual method to set the non workspace properties for this algorithm.

To be overridden by specific algorithms when needed.

Parameters

alg	:: pointer to the algorithm
propertyName	:: name of the property
propertyValue	:: value of the property
periodNum	:: period number

Reimplemented in Mantid::DataHandling::SaveCanSAS1D, Mantid::DataHandling::SaveGSS, Mantid::DataHandling::SaveFocusedXYE, Mantid::DataHandling::SaveNexus, and Mantid::DataHandling::SaveNexusProcessed.

Definition at line 1565 of file Algorithm.cpp.

References Mantid::Kernel::IPropertyManager::setPropertyValue().

Referenced by copyNonWorkspaceProperties(), Mantid::DataHandling::SaveCanSAS1D::setOtherProperties(), Mantid::DataHandling::SaveGSS::setOtherProperties(), Mantid::DataHandling::SaveFocusedXYE::setOtherProperties(), Mantid::DataHandling::SaveNexus::setOtherProperties(), and Mantid::DataHandling::SaveNexusProcessed::setOtherProperties().

◆ setProperties() [1/2]

void Mantid::API::Algorithm::setProperties	(	const ::Json::Value &	jsonValue,
		const std::unordered_set< std::string > &	ignoreProperties = `std::unordered_set<std::string>()`,
		bool	createMissing = `false`
	)

overridevirtual

Sets all the declared properties from a json object.

Parameters

jsonValue	:: A json name value pair collection
ignoreProperties	:: A set of names of any properties NOT to set from the propertiesArray
createMissing	:: If the property does not exist then create it

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1841 of file Algorithm.cpp.

References m_properties, and Mantid::Kernel::PropertyManagerOwner::setProperties().

◆ setProperties() [2/2]

void Mantid::API::Algorithm::setProperties	(	const std::string &	propertiesJson,
		const std::unordered_set< std::string > &	ignoreProperties = `std::unordered_set<std::string>()`,
		bool	createMissing = `false`
	)

overridevirtual

Set the ordered list of properties by one string of values, separated by semicolons.

The string should be a json formatted collection of name value pairs

Parameters

propertiesJson	:: The string of property values
ignoreProperties	:: A set of names of any properties NOT to set from the propertiesArray
createMissing	:: If the property does not exist then create it

Exceptions

invalid_argument if error in parameters

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1830 of file Algorithm.cpp.

References m_properties, and Mantid::Kernel::PropertyManagerOwner::setProperties().

◆ setPropertiesWithString()

void Mantid::API::Algorithm::setPropertiesWithString	(	const std::string &	propertiesString,
		const std::unordered_set< std::string > &	ignoreProperties = `std::unordered_set<std::string>()`
	)

overridevirtual

Sets all the declared properties from a string.

Parameters

propertiesString	:: A list of name = value pairs separated by a semicolon
ignoreProperties	:: A set of names of any properties NOT to set from the propertiesArray

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1852 of file Algorithm.cpp.

References m_properties, and Mantid::Kernel::PropertyManagerOwner::setPropertiesWithString().

◆ setPropertyOrdinal()

void Mantid::API::Algorithm::setPropertyOrdinal	(	const int &	index,
		const std::string &	value
	)

overridevirtual

Set the value of a property by an index N.B.

bool properties must be set using 1/0 rather than true/false

Parameters

index	:: The index of the property to assign
value	:: The value to assign to the property

Exceptions

std::runtime_error if the property index is too high

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1888 of file Algorithm.cpp.

References afterPropertySet(), Mantid::Kernel::PropertyManagerOwner::getPointerToPropertyOrdinal(), index, m_properties, Mantid::Kernel::Property::name(), Mantid::Kernel::PropertyManagerOwner::setPropertyOrdinal(), and value.

◆ setPropertyValue()

void Mantid::API::Algorithm::setPropertyValue	(	const std::string &	name,
		const std::string &	value
	)

overridevirtual

Set the value of a property by string N.B.

bool properties must be set using 1/0 rather than true/false

Parameters

name	:: The name of the property (case insensitive)
value	:: The value to assign to the property

Exceptions

Exception::NotFoundError	if the named property is unknown
std::invalid_argument	If the value is not valid for the property given

Implements Mantid::Kernel::IPropertyManager.

Reimplemented in Mantid::DataHandling::Load.

Definition at line 1865 of file Algorithm.cpp.

References afterPropertySet(), m_properties, name(), Mantid::Kernel::PropertyManagerOwner::setPropertyValue(), and value.

Referenced by Mantid::DataHandling::LoadILLSANS::applySensitivityMap(), Mantid::Algorithms::DirectILLTubeBackground::components(), Mantid::CurveFitting::Algorithms::Fit::createOutput(), Mantid::CurveFitting::Algorithms::DoublePulseFit::declareAdditionalProperties(), Mantid::Algorithms::FindCenterOfMassPosition::exec(), Mantid::Algorithms::GenerateIPythonNotebook::exec(), Mantid::Algorithms::GeneratePythonScript::exec(), Mantid::Algorithms::SpatialGrouping::exec(), Mantid::Algorithms::TOFSANSResolution::exec(), Mantid::CurveFitting::Algorithms::Fit1D::exec(), Mantid::DataHandling::LoadInstrument::exec(), Mantid::DataHandling::UpdateInstrumentFromFile::exec(), Mantid::MDAlgorithms::LoadGaussCube::exec(), Mantid::WorkflowAlgorithms::EQSANSLoad::exec(), Mantid::WorkflowAlgorithms::HFIRDarkCurrentSubtraction::exec(), Mantid::WorkflowAlgorithms::HFIRLoad::exec(), Mantid::WorkflowAlgorithms::SANSSensitivityCorrection::exec(), Mantid::WorkflowAlgorithms::SetupEQSANSReduction::exec(), Mantid::WorkflowAlgorithms::SetupHFIRReduction::exec(), Mantid::CurveFitting::Algorithms::ProfileChiSquared1D::execConcrete(), Mantid::Algorithms::Q1DWeighted::finalize(), Mantid::CurveFitting::Algorithms::Fit::finalizeMinimizer(), Mantid::Algorithms::Qhelper::outputParts(), processGroups(), Mantid::Algorithms::PolarizationEfficienciesWildes::resetPropertyValue(), SANSInstrumentCreationHelper::runLoadInstrument(), Mantid::DataHandling::FindDetectorsPar::setOutputTable(), Mantid::DataHandling::Load::setPropertyValue(), Mantid::Algorithms::CreateDetectorTable::setTableToOutput(), Mantid::CurveFitting::Functions::ProcessBackground::setupDummyOutputWSes(), and Mantid::Algorithms::FindCenterOfMassPosition2::storeOutputWorkspace().

◆ setPropertyValueFromJson()

void Mantid::API::Algorithm::setPropertyValueFromJson	(	const std::string &	name,
		const Json::Value &	value
	)

overridevirtual

Set the value of a property by Json::Value object.

Parameters

name	:: The name of the property (case insensitive)
value	:: The value to assign to the property

Exceptions

Exception::NotFoundError	if the named property is unknown
std::invalid_argument	If the value is not valid for the property given

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1877 of file Algorithm.cpp.

References afterPropertySet(), m_properties, name(), Mantid::Kernel::PropertyManagerOwner::setPropertyValueFromJson(), and value.

◆ setResultState()

void Mantid::API::Algorithm::setResultState ( const ResultState state )

protected

Sets the result execution state.

Sets the result execution state if set to Success or Failed will also set the execution state to finished.

Definition at line 139 of file Algorithm.cpp.

References Mantid::API::Finished, m_resultState, Mantid::API::NotFinished, and setExecutionState().

Referenced by doCallProcessGroups(), and executeInternal().

◆ setRethrows()

void Mantid::API::Algorithm::setRethrows ( const bool rethrow )

overridevirtual

Set whether the algorithm will rethrow exceptions.

Parameters

rethrow :: true if you want to rethrow exception.

Implements Mantid::API::IAlgorithm.

Definition at line 202 of file Algorithm.cpp.

References m_rethrow.

◆ setupAsChildAlgorithm()

void Mantid::API::Algorithm::setupAsChildAlgorithm	(	const Algorithm_sptr &	alg,
		const double	startProgress = `-1.`,
		const double	endProgress = `-1.`,
		const bool	enableLogging = `true`
	)

Setup algorithm as child algorithm.

Used internally by createChildAlgorithm. Arguments are as documented there. Can also be used manually for algorithms created otherwise. This allows running algorithms that are not declared into the factory as child algorithms.

Definition at line 873 of file Algorithm.cpp.

References m_ChildAlgorithms, m_endChildProgress, m_startChildProgress, Mantid::Kernel::Direction::Output, PARALLEL_CRITICAL, and progressObserver().

Referenced by createChildAlgorithm(), and Mantid::Algorithms::ExtractSpectra::exec().

◆ setWorkspaceInputProperties() [1/2]

template<typename T1 , typename T2 , typename , typename >

void Mantid::API::Algorithm::setWorkspaceInputProperties	(	const std::string &	name,
		const std::shared_ptr< T1 > &	wksp,
		IndexType	type,
		const T2 &	list
	)

Mechanism for setting the index property with a workspace shared pointer.

This method can only be used if T1 is convertible to a MatrixWorkspace and T2 is either std::string or std::vector<int>

Parameters

name	Property name
wksp	Workspace as a pointer
type	Index type IndexType::WorkspaceIndex or IndexType::SpectrumNum
list	List of indices to be used.

Definition at line 99 of file Algorithm.hxx.

References name().

◆ setWorkspaceInputProperties() [2/2]

template<typename T1 , typename T2 , typename , typename >

void Mantid::API::Algorithm::setWorkspaceInputProperties	(	const std::string &	name,
		const std::string &	wsName,
		IndexType	type,
		const T2 &	list
	)

Mechanism for setting the index property with a workspace shared pointer.

This method can only be used if T1 is convertible to a MatrixWorkspace and T2 is either std::string or std::vector<int64_t>

Parameters

name	Property name
wsName	Workspace name as string
type	Index type IndexType::WorkspaceIndex or IndexType::SpectrumNum
list	List of indices to be used.

Definition at line 114 of file Algorithm.hxx.

References name().

◆ store()

void Mantid::API::Algorithm::store ( )

protected

Stores any output workspaces into the AnalysisDataService.

Exceptions

std::runtime_error If unable to successfully store an output workspace

Definition at line 805 of file Algorithm.cpp.

References getProperties(), group, and Mantid::API::IWorkspaceProperty::store().

Referenced by doCallProcessGroups(), and executeInternal().

◆ summary()

const std::string Mantid::API::Algorithm::summary ( ) const

overridepure virtual

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

Implements Mantid::API::IAlgorithm.

◆ takeProperty()

std::unique_ptr< Kernel::Property > Mantid::API::Algorithm::takeProperty ( const size_t index )

overridevirtual

Removes the property from management and returns a pointer to it.

Removes a property from the properties map by index and return a pointer to it.

Parameters

index :: index of the property to be removed

Returns: :: pointer to the removed property if found, NULL otherwise

Implements Mantid::Kernel::IPropertyManager.

Definition at line 2008 of file Algorithm.cpp.

References index, m_properties, and Mantid::Kernel::PropertyManagerOwner::takeProperty().

◆ toJson()

Json::Value Mantid::API::Algorithm::toJson ( ) const

overridevirtual

Serialize an object to a json object.

Serialize this object to a json object)

Returns: This object serialized as a json object

Implements Mantid::API::IAlgorithm.

Definition at line 929 of file Algorithm.cpp.

References Mantid::Kernel::PropertyManagerOwner::asJson(), m_properties, name(), and version().

Referenced by toString().

◆ toString()

std::string Mantid::API::Algorithm::toString ( ) const

overridevirtual

Serialize an object to a string.

Serialize this object to a string.

The format is a json formatted string.

Returns: This object serialized as a string

Implements Mantid::API::IAlgorithm.

Definition at line 923 of file Algorithm.cpp.

References toJson().

◆ trackAlgorithmHistory()

void Mantid::API::Algorithm::trackAlgorithmHistory ( std::shared_ptr< AlgorithmHistory > parentHist )

set whether we wish to track the child algorithm's history and pass it the parent object to fill.

Indicates that this algrithms history should be tracked regardless of if it is a child.

Parameters

parentHist :: the parent algorithm history object the history in.

Definition at line 1073 of file Algorithm.cpp.

References enableHistoryRecordingForChild(), and m_parentHistory.

◆ trackingHistory()

bool Mantid::API::Algorithm::trackingHistory ( )

protected

get whether we are tracking the history for this algorithm,

Check if we are tracking history for this algorithm.

Returns: if we are tracking the history of this algorithm

Definition at line 1081 of file Algorithm.cpp.

References isChild(), and m_recordHistoryForChild.

Referenced by cacheInputWorkspaceHistories(), doCallProcessGroups(), Mantid::DataHandling::SaveNexusProcessed::doExec(), executeInternal(), and Mantid::DataHandling::SaveNexus::runSaveNexusProcessed().

◆ unlockWorkspaces()

void Mantid::API::Algorithm::unlockWorkspaces ( )

private

Unlock any previously locked workspaces.

Definition at line 480 of file Algorithm.cpp.

References Mantid::Kernel::Logger::debug(), g_log, isChild(), m_readLockedWorkspaces, and m_writeLockedWorkspaces.

Referenced by executeInternal().

◆ validateInputs()

std::map< std::string, std::string > Mantid::API::Algorithm::validateInputs ( void )

overridevirtual

Perform validation of ALL the input properties of the algorithm.

This is to be overridden by specific algorithms. It will be called in dialogs after parsing all inputs and setting the properties, but BEFORE executing.

Returns: a map where: Key = string name of the property; Value = string describing the problem with the property.

Implements Mantid::API::IAlgorithm.

Definition at line 332 of file Algorithm.cpp.

Referenced by executeInternal().

◆ validateProperties()

bool Mantid::API::Algorithm::validateProperties ( ) const

overridevirtual

Validates all the properties in the collection.

Returns: True if all properties have a valid value

Implements Mantid::Kernel::IPropertyManager.

Definition at line 1903 of file Algorithm.cpp.

References m_properties, and Mantid::Kernel::PropertyManagerOwner::validateProperties().

Referenced by executeInternal().

◆ version()

int Mantid::API::Algorithm::version ( ) const

overridepure virtual

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

Implements Mantid::API::IAlgorithm.

Referenced by createChildAlgorithm(), Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::API::AlgorithmHistory::fillAlgorithmHistory(), processGroups(), Mantid::API::MultiPeriodGroupWorker::processGroups(), registerFeatureUsage(), and toJson().

◆ workspaceMethodInputProperty()

const std::string Mantid::API::Algorithm::workspaceMethodInputProperty ( ) const

overridevirtual

Returns: The name of the property that the calling object will be passed to.

Implements Mantid::API::IAlgorithm.

Reimplemented in Mantid::DataHandling::MaskDetectors.

Definition at line 281 of file Algorithm.cpp.

◆ workspaceMethodName()

const std::string Mantid::API::Algorithm::workspaceMethodName ( ) const

overridevirtual

Returns: A string giving the method name that should be attached to a workspace

Implements Mantid::API::IAlgorithm.

Reimplemented in Mantid::DataHandling::MaskDetectors.

Definition at line 264 of file Algorithm.cpp.

◆ workspaceMethodOn()

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

overridevirtual

Returns: A list of workspace class names that should have the workspaceMethodName attached

Implements Mantid::API::IAlgorithm.

Definition at line 271 of file Algorithm.cpp.

References Mantid::Kernel::StringTokenizer::asVector(), Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY, Mantid::Kernel::StringTokenizer::TOK_TRIM, and workspaceMethodOnTypes().

◆ workspaceMethodOnTypes()

virtual const std::string Mantid::API::Algorithm::workspaceMethodOnTypes ( ) const

inlineprotectedvirtual

Returns a semi-colon separated list of workspace types to attach this algorithm.

Reimplemented in Mantid::Algorithms::Rebin.

Definition at line 364 of file Algorithm.h.

Referenced by workspaceMethodOn().

Friends And Related Symbol Documentation

◆ Progress

friend class Progress

friend

Definition at line 375 of file Algorithm.h.

◆ WorkspaceHistory

friend class WorkspaceHistory

friend

Definition at line 408 of file Algorithm.h.

Member Data Documentation

◆ calledByAlias

bool Mantid::API::Algorithm::calledByAlias = false

Flag to indicate if the algorithm is called by its alias.

Definition at line 172 of file Algorithm.h.

Referenced by executeInternal().

◆ g_execCount

size_t Mantid::API::Algorithm::g_execCount = 0

staticprotected

Counter to keep track of algorithm execution order.

Initialize static algorithm counter.

Definition at line 410 of file Algorithm.h.

Referenced by doCallProcessGroups(), Mantid::DataHandling::SaveNexusProcessed::doExec(), executeInternal(), Mantid::API::WorkspaceHistory::parseAlgorithmHistory(), and Mantid::DataHandling::SaveNexus::runSaveNexusProcessed().

◆ g_log

Kernel::Logger& Mantid::API::Algorithm::g_log

protected

Definition at line 422 of file Algorithm.h.

◆ m_algorithmID

AlgorithmID Mantid::API::Algorithm::m_algorithmID

private

Algorithm ID for managed algorithms.

Definition at line 494 of file Algorithm.h.

◆ m_alwaysStoreInADS

bool Mantid::API::Algorithm::m_alwaysStoreInADS

private

Always store in the ADS, even for child algos.

Definition at line 484 of file Algorithm.h.

Referenced by doCallProcessGroups(), executeInternal(), getAlwaysStoreInADS(), reportCompleted(), and setAlwaysStoreInADS().

◆ m_cancel

std::atomic<bool> Mantid::API::Algorithm::m_cancel

protected

Set to true to stop execution.

Definition at line 404 of file Algorithm.h.

Referenced by Mantid::MDAlgorithms::BinMD::binByIterating(), cancel(), getCancel(), and interruption_point().

◆ m_ChildAlgorithms

std::vector<std::weak_ptr<IAlgorithm> > Mantid::API::Algorithm::m_ChildAlgorithms

private

A list of weak pointers to any child algorithms created.

Definition at line 495 of file Algorithm.h.

Referenced by cancel(), and setupAsChildAlgorithm().

◆ m_endChildProgress

double Mantid::API::Algorithm::m_endChildProgress

mutableprivate

Keeps value for algorithm's progress at Child Algorithm's finish.

Definition at line 492 of file Algorithm.h.

Referenced by handleChildProgressNotification(), and setupAsChildAlgorithm().

◆ m_executeAsync

std::unique_ptr<Poco::ActiveMethod<bool, Poco::Void, Algorithm, Poco::ActiveStarter<Algorithm> > > Mantid::API::Algorithm::m_executeAsync

private

Poco::ActiveMethod used to implement asynchronous execution.

Definition at line 470 of file Algorithm.h.

Referenced by executeAsync().

◆ m_executionState

std::atomic<ExecutionState> Mantid::API::Algorithm::m_executionState

private

the current execution state

Definition at line 479 of file Algorithm.h.

Referenced by executionState(), isInitialized(), and setExecutionState().

◆ m_gcTime

Mantid::Types::Core::DateAndTime Mantid::API::Algorithm::m_gcTime

private

The earliest this class should be considered for garbage collection.

Definition at line 525 of file Algorithm.h.

Referenced by executeInternal(), and isReadyForGarbageCollection().

◆ m_groupsHaveSimilarNames

bool Mantid::API::Algorithm::m_groupsHaveSimilarNames

private

All the groups have similar names (group_1, group_2 etc.)

Definition at line 516 of file Algorithm.h.

Referenced by checkGroups(), and processGroups().

◆ m_groupSize

size_t Mantid::API::Algorithm::m_groupSize

protected

Size of the group(s) being processed.

Definition at line 431 of file Algorithm.h.

Referenced by checkGroups(), and processGroups().

◆ m_groupWorkspaces

std::vector<std::shared_ptr<WorkspaceGroup> > Mantid::API::Algorithm::m_groupWorkspaces

private

Pointer to the WorkspaceGroup (if any) for each input workspace property.

Definition at line 512 of file Algorithm.h.

Referenced by checkGroups(), and clearWorkspaceCaches().

◆ m_history

std::shared_ptr<AlgorithmHistory> Mantid::API::Algorithm::m_history

protected

Pointer to the history for the algorithm being executed.

Definition at line 418 of file Algorithm.h.

Referenced by doCallProcessGroups(), Mantid::DataHandling::SaveNexusProcessed::doExec(), executeInternal(), Mantid::Algorithms::ConjoinXRuns::fillHistory(), fillHistory(), linkHistoryWithLastChild(), and Mantid::DataHandling::SaveNexus::runSaveNexusProcessed().

◆ m_inputWorkspaceHistories

std::vector<Workspace_sptr> Mantid::API::Algorithm::m_inputWorkspaceHistories

private

Store a pointer to the input workspace histories so they can be copied to the outputs to avoid anything being overwritten.

Definition at line 519 of file Algorithm.h.

Referenced by cacheInputWorkspaceHistories(), clearWorkspaceCaches(), and fillHistory().

◆ m_inputWorkspaceProps

std::vector<IWorkspaceProperty *> Mantid::API::Algorithm::m_inputWorkspaceProps

protected

All the WorkspaceProperties that are Input or InOut. Set in execute()

Definition at line 416 of file Algorithm.h.

Referenced by cacheWorkspaceProperties(), checkGroups(), clearWorkspaceCaches(), lockWorkspaces(), and processGroups().

◆ m_isAlgStartupLoggingEnabled

bool Mantid::API::Algorithm::m_isAlgStartupLoggingEnabled

private

Definition at line 487 of file Algorithm.h.

Referenced by getAlgStartupLogging(), logAlgorithmInfo(), reportCompleted(), and setAlgStartupLogging().

◆ m_isChildAlgorithm

bool Mantid::API::Algorithm::m_isChildAlgorithm

private

Algorithm is a child algorithm.

Definition at line 481 of file Algorithm.h.

Referenced by executeInternal(), isChild(), reportCompleted(), and setChild().

◆ m_log

Kernel::Logger Mantid::API::Algorithm::m_log

protected

Logger for this algorithm.

Definition at line 421 of file Algorithm.h.

Referenced by Mantid::DataHandling::LoadNexusMonitors2::createOutputWorkspace(), Mantid::Algorithms::GetEiMonDet3::exec(), and Mantid::DataHandling::LoadInstrument::exec().

◆ m_notificationCenter

std::unique_ptr<Poco::NotificationCenter> Mantid::API::Algorithm::m_notificationCenter

mutableprivate

Sends notifications to observers.

Observers can subscribe to notificationCenter using Poco::NotificationCenter::addObserver(...);

Definition at line 475 of file Algorithm.h.

Referenced by notificationCenter().

◆ m_outputWorkspaceProps

std::vector<IWorkspaceProperty *> Mantid::API::Algorithm::m_outputWorkspaceProps

private

All the WorkspaceProperties that are Output or InOut. Set in execute()

Definition at line 507 of file Algorithm.h.

Referenced by cacheWorkspaceProperties(), clearWorkspaceCaches(), and lockWorkspaces().

◆ m_parallelException

std::atomic<bool> Mantid::API::Algorithm::m_parallelException

protected

Set if an exception is thrown, and not caught, within a parallel region.

Definition at line 406 of file Algorithm.h.

◆ m_parentHistory

std::shared_ptr<AlgorithmHistory> Mantid::API::Algorithm::m_parentHistory

protected

Pointer to the parent history object (if set)

Definition at line 425 of file Algorithm.h.

Referenced by Mantid::DataHandling::SaveNexusProcessed::doExec(), Mantid::Algorithms::ConjoinXRuns::fillHistory(), fillHistory(), Mantid::DataHandling::SaveNexus::runSaveNexusProcessed(), and trackAlgorithmHistory().

◆ m_progressObserver

std::unique_ptr<Poco::NObserver<Algorithm, ProgressNotification> > Mantid::API::Algorithm::m_progressObserver

mutableprivate

Child algorithm progress observer.

Definition at line 477 of file Algorithm.h.

Referenced by progressObserver().

◆ m_properties

Mantid::Kernel::PropertyManagerOwner Mantid::API::Algorithm::m_properties

private

◆ m_pureOutputWorkspaceProps

std::vector<IWorkspaceProperty *> Mantid::API::Algorithm::m_pureOutputWorkspaceProps

private

All the WorkspaceProperties that are Output (not inOut). Set in execute()

Definition at line 509 of file Algorithm.h.

Referenced by cacheWorkspaceProperties(), clearWorkspaceCaches(), and processGroups().

◆ m_readLockedWorkspaces

WorkspaceVector Mantid::API::Algorithm::m_readLockedWorkspaces

private

Vector of all the workspaces that have been read-locked.

Definition at line 502 of file Algorithm.h.

Referenced by lockWorkspaces(), and unlockWorkspaces().

◆ m_recordHistoryForChild

bool Mantid::API::Algorithm::m_recordHistoryForChild

private

Flag to indicate whether history should be recorded.

Applicable to child algs only

Definition at line 482 of file Algorithm.h.

Referenced by enableHistoryRecordingForChild(), fillHistory(), linkHistoryWithLastChild(), and trackingHistory().

◆ m_reservedList

std::vector<std::string> Mantid::API::Algorithm::m_reservedList

private

Reserved property names.

Definition at line 522 of file Algorithm.h.

Referenced by declareWorkspaceInputProperties(), and isCompoundProperty().

◆ m_resultState

std::atomic<ResultState> Mantid::API::Algorithm::m_resultState

private

the current result State

Definition at line 480 of file Algorithm.h.

Referenced by resultState(), and setResultState().

◆ m_rethrow

bool Mantid::API::Algorithm::m_rethrow

private

Algorithm should rethrow exceptions while executing.

Definition at line 486 of file Algorithm.h.

Referenced by executeInternal(), and setRethrows().

◆ m_runningAsync

bool Mantid::API::Algorithm::m_runningAsync

private

Algorithm is running asynchronously.

Definition at line 485 of file Algorithm.h.

Referenced by doCallProcessGroups(), executeAsyncImpl(), and executeInternal().

◆ m_singleGroup

int Mantid::API::Algorithm::m_singleGroup

private

If only one input is a group, this is its index. -1 if they are all groups.

Definition at line 514 of file Algorithm.h.

Referenced by checkGroups(), and processGroups().

◆ m_startChildProgress

double Mantid::API::Algorithm::m_startChildProgress

mutableprivate

Whether to log alg startup and closedown messages from the base class (default = true)

Keeps value for algorithm's progress at start of an Child Algorithm

Definition at line 490 of file Algorithm.h.

Referenced by handleChildProgressNotification(), and setupAsChildAlgorithm().

◆ m_unrolledInputWorkspaces

std::vector<WorkspaceVector> Mantid::API::Algorithm::m_unrolledInputWorkspaces

protected

One vector of workspaces for each input workspace property.

A group is unrolled to its constituent members

Definition at line 429 of file Algorithm.h.

Referenced by checkGroups(), clearWorkspaceCaches(), processGroups(), Mantid::DataHandling::SaveNexusESS::processGroups(), and Mantid::DataHandling::SaveNexusProcessed::processGroups().

◆ m_usingBaseProcessGroups

bool Mantid::API::Algorithm::m_usingBaseProcessGroups = false

protected

distinguish between base processGroups() and overriden/algorithm specific versions

Definition at line 434 of file Algorithm.h.

Referenced by doCallProcessGroups(), processGroups(), and Mantid::API::MultiPeriodGroupAlgorithm::processGroups().

◆ m_writeLockedWorkspaces

WorkspaceVector Mantid::API::Algorithm::m_writeLockedWorkspaces

private

Vector of all the workspaces that have been write-locked.

Definition at line 504 of file Algorithm.h.

Referenced by lockWorkspaces(), and unlockWorkspaces().

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

Framework/API/inc/MantidAPI/Algorithm.h
Framework/API/inc/MantidAPI/Algorithm.hxx
Framework/API/src/Algorithm.cpp
Framework/API/src/AlgorithmExecuteProfile.cpp

Classes

Public Member Functions

Serialization functions

Algorithm Information

Progress Reporting functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ WorkspaceVector

Constructor & Destructor Documentation

◆ Algorithm() [1/2]

◆ Algorithm() [2/2]

◆ ~Algorithm()

Member Function Documentation

◆ addObserver()

◆ addTimer()

◆ afterPropertySet()

◆ alias()

◆ aliasDeprecated()

◆ asJson()

◆ asString()

◆ cacheInputWorkspaceHistories()

◆ cacheWorkspaceProperties()

◆ cancel()

◆ categories()

◆ category()

◆ categorySeparator()

◆ checkGroups()

◆ clear()

◆ clearWorkspaceCaches()

◆ copyNonWorkspaceProperties()

◆ copyPropertiesFrom()

◆ createChildAlgorithm()

◆ declareOrReplaceProperty()

◆ declareProperty() [1/8]

◆ declareProperty() [2/8]

◆ declareProperty() [3/8]

◆ declareProperty() [4/8]

◆ declareProperty() [5/8]

◆ declareProperty() [6/8]

◆ declareProperty() [7/8]

◆ declareProperty() [8/8]

◆ declareWorkspaceInputProperties()

◆ doCallProcessGroups()

◆ doSetInputProperties()

◆ enableHistoryRecordingForChild()

◆ exec()

◆ execute()

◆ executeAsChildAlg()

◆ executeAsync()

◆ executeAsyncImpl()

◆ executeInternal()

◆ executionState()

◆ existsProperty()

◆ fillHistory() [1/2]

◆ fillHistory() [2/2]

◆ findWorkspaces()

◆ fromHistory()

◆ fromJson()

◆ fromString()

◆ getAlgorithmID()

◆ getAlgStartupLogging()

◆ getAlwaysStoreInADS()

◆ getCancel()

◆ getDeclaredPropertyNames()

◆ getLogger()

◆ getLoggingOffset()

◆ getPointerToProperty()

◆ getPointerToPropertyOrdinal()

◆ getProperties()

◆ getProperty()

◆ getPropertyValue()

◆ getWorkspaceAndIndices()

◆ handleChildProgressNotification()

◆ helpURL()

◆ init()

◆ initialize()

◆ interruption_point()

◆ isChild()

◆ isCompoundProperty()