#include <TaskBasedAlgorithm.h>

Public Member Functions
size_t	addDependantTaskSet ()

	AlgorithmTask (T *parent, const std::string &name)

void	clear ()

void	execute ()

const std::vector< std::string > &	getExpectedOutputs () const

const std::string &	getSelectedOutput () const

void	initAsFirstTask (std::shared_ptr< MatrixWorkspace > inputWS)

const std::string &	name () const

void	setDependantTask (const std::string &task, const std::string &output_name="", const std::string &alias="", const size_t dependantTaskSet=0)

void	setExpectedOutputs (const std::vector< std::string > &expectedOutputs)

void	setTaskExecutionOrder (const std::vector< std::string > *taskExecutionOrder)

Protected Member Functions
std::shared_ptr< MatrixWorkspace >	getDependantWorkspace (const std::string &outputAlias)

void	outputWorkspace (std::shared_ptr< MatrixWorkspace > ws, const std::string &outputName)

void	setSelectedOutput (const std::string &output, const bool overwrite=false)

Protected Attributes
T *	m_parent

Private Member Functions
void	activateTaskSet ()

void	addDependantTaskOutput (const std::string &outputName, std::shared_ptr< MatrixWorkspace > ws, const size_t taskSetIndex)

void	checkExpectedOutputs ()

std::vector< std::string >	evaluateDependentTasks ()

virtual void	executeImpl ()=0

std::string	populateDependantTasks (const size_t taskSetIndex)

Private Attributes
size_t	m_activeDependantTaskSet

std::vector< std::unordered_map< std::string, std::shared_ptr< MatrixWorkspace > > >	m_dependantOutputs

std::vector< std::unordered_map< std::string, std::vector< std::pair< std::string, std::string > > > >	m_dependantTasks

std::vector< std::string >	m_expectedOutputs

bool	m_firstTaskFlag

std::vector< size_t >	m_fulfilledDependantTaskSets

std::string	m_name

std::string	m_selectedOutput

const std::vector< std::string > *	m_taskExecutionOrder = nullptr

Detailed Description

template<class T>
class Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask

Definition at line 28 of file TaskBasedAlgorithm.h.

Constructor & Destructor Documentation

◆ AlgorithmTask()

template<class T >

Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::AlgorithmTask	(	T *	parent,
		const std::string &	name
	)

inlineexplicit

Definition at line 30 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::addDependantTaskSet().

Member Function Documentation

◆ activateTaskSet()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::activateTaskSet ( )

inlineprivate

Definition at line 131 of file TaskBasedAlgorithm.h.

References index, and Mantid::API::TaskBasedAlgorithm< T >::m_taskExecutionOrder.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute().

◆ addDependantTaskOutput()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::addDependantTaskOutput	(	const std::string &	outputName,
		std::shared_ptr< MatrixWorkspace >	ws,
		const size_t	taskSetIndex
	)

inlineprivate

Definition at line 219 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::initAsFirstTask().

◆ addDependantTaskSet()

template<class T >

size_t Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::addDependantTaskSet ( )

inline

Definition at line 34 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantOutputs, and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantTasks.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::AlgorithmTask().

◆ checkExpectedOutputs()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::checkExpectedOutputs ( )

inlineprivate

Definition at line 161 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute().

◆ clear()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::clear ( )

inline

Definition at line 77 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_fulfilledDependantTaskSets.

◆ evaluateDependentTasks()

template<class T >

std::vector< std::string > Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::evaluateDependentTasks ( )

inlineprivate

Definition at line 177 of file TaskBasedAlgorithm.h.

References std::to_string().

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute().

◆ execute()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute ( )

inline

Definition at line 52 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::activateTaskSet(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::checkExpectedOutputs(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::evaluateDependentTasks(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::executeImpl(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_name, and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_parent.

◆ executeImpl()

template<class T >

virtual void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::executeImpl ( )

privatepure virtual

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute().

◆ getDependantWorkspace()

template<class T >

std::shared_ptr< MatrixWorkspace > Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getDependantWorkspace ( const std::string & outputAlias )

inlineprotected

Definition at line 86 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_activeDependantTaskSet, and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantOutputs.

◆ getExpectedOutputs()

template<class T >

const std::vector< std::string > & Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getExpectedOutputs ( ) const

inline

Definition at line 66 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_expectedOutputs.

◆ getSelectedOutput()

template<class T >

const std::string & Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getSelectedOutput ( ) const

inline

Definition at line 76 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_selectedOutput.

◆ initAsFirstTask()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::initAsFirstTask ( std::shared_ptr< MatrixWorkspace > inputWS )

inline

Definition at line 69 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::addDependantTaskOutput(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_firstTaskFlag.

◆ name()

template<class T >

const std::string & Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::name ( ) const

inline

Definition at line 68 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_name.

◆ outputWorkspace()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::outputWorkspace	(	std::shared_ptr< MatrixWorkspace >	ws,
		const std::string &	outputName
	)

inlineprotected

Definition at line 81 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_name, Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_parent, and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setSelectedOutput().

◆ populateDependantTasks()

template<class T >

std::string Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::populateDependantTasks ( const size_t taskSetIndex )

inlineprivate

Definition at line 113 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantTasks, and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_parent.

◆ setDependantTask()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setDependantTask	(	const std::string &	task,
		const std::string &	output_name = `""`,
		const std::string &	alias = `""`,
		const size_t	dependantTaskSet = `0`
	)

inline

Definition at line 39 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantTasks, Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_name, and std::to_string().

◆ setExpectedOutputs()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setExpectedOutputs ( const std::vector< std::string > & expectedOutputs )

inline

Definition at line 67 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_expectedOutputs.

◆ setSelectedOutput()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setSelectedOutput	(	const std::string &	output,
		const bool	overwrite = `false`
	)

inlineprotected

Definition at line 90 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_selectedOutput.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::outputWorkspace().

◆ setTaskExecutionOrder()

template<class T >

void Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setTaskExecutionOrder ( const std::vector< std::string > * taskExecutionOrder )

inline

Definition at line 73 of file TaskBasedAlgorithm.h.

References Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_taskExecutionOrder.

Member Data Documentation

◆ m_activeDependantTaskSet

template<class T >

size_t Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_activeDependantTaskSet

private

Definition at line 104 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getDependantWorkspace().

◆ m_dependantOutputs

template<class T >

std::vector<std::unordered_map<std::string, std::shared_ptr<MatrixWorkspace> > > Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantOutputs

private

Definition at line 102 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::addDependantTaskSet(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getDependantWorkspace().

◆ m_dependantTasks

template<class T >

std::vector<std::unordered_map<std::string, std::vector<std::pair<std::string, std::string> > > > Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_dependantTasks

private

Definition at line 99 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::addDependantTaskSet(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::populateDependantTasks(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setDependantTask().

◆ m_expectedOutputs

template<class T >

std::vector<std::string> Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_expectedOutputs

private

Definition at line 101 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getExpectedOutputs(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setExpectedOutputs().

◆ m_firstTaskFlag

template<class T >

bool Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_firstTaskFlag

private

Definition at line 103 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::initAsFirstTask().

◆ m_fulfilledDependantTaskSets

template<class T >

std::vector<size_t> Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_fulfilledDependantTaskSets

private

Definition at line 105 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::clear().

◆ m_name

template<class T >

std::string Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_name

private

Definition at line 100 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::name(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::outputWorkspace(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setDependantTask().

◆ m_parent

template<class T >

T* Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_parent

protected

Definition at line 80 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::execute(), Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::outputWorkspace(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::populateDependantTasks().

◆ m_selectedOutput

template<class T >

std::string Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_selectedOutput

private

Definition at line 107 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::getSelectedOutput(), and Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setSelectedOutput().

◆ m_taskExecutionOrder

template<class T >

const std::vector<std::string>* Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::m_taskExecutionOrder = nullptr

private

Definition at line 106 of file TaskBasedAlgorithm.h.

Referenced by Mantid::API::TaskBasedAlgorithm< T >::AlgorithmTask::setTaskExecutionOrder().

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

Framework/API/inc/MantidAPI/TaskBasedAlgorithm.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AlgorithmTask()

Member Function Documentation

◆ activateTaskSet()

◆ addDependantTaskOutput()

◆ addDependantTaskSet()

◆ checkExpectedOutputs()

◆ clear()

◆ evaluateDependentTasks()

◆ execute()

◆ executeImpl()

◆ getDependantWorkspace()

◆ getExpectedOutputs()

◆ getSelectedOutput()

◆ initAsFirstTask()

◆ name()

◆ outputWorkspace()

◆ populateDependantTasks()

◆ setDependantTask()

◆ setExpectedOutputs()

◆ setSelectedOutput()

◆ setTaskExecutionOrder()

Member Data Documentation

◆ m_activeDependantTaskSet

◆ m_dependantOutputs

◆ m_dependantTasks

◆ m_expectedOutputs

◆ m_firstTaskFlag

◆ m_fulfilledDependantTaskSets

◆ m_name

◆ m_parent

◆ m_selectedOutput

◆ m_taskExecutionOrder