MantidQt::API::AlgorithmRunner Class Reference

#include <AlgorithmRunner.h>

Inheritance diagram for MantidQt::API::AlgorithmRunner:

Public Member Functions
	AlgorithmRunner (std::unique_ptr< IJobRunner > jobRunner)
void	execute (IConfiguredAlgorithm_sptr algorithm) override
void	execute (std::deque< IConfiguredAlgorithm_sptr > algorithmQueue) override
void	notifyAlgorithmComplete (IConfiguredAlgorithm_sptr &algorithm) override
void	notifyAlgorithmError (IConfiguredAlgorithm_sptr &algorithm, std::string const &message) override
void	notifyAlgorithmStarted (IConfiguredAlgorithm_sptr &algorithm) override
void	notifyBatchCancelled () override
void	notifyBatchComplete (bool error) override
void	subscribe (IAlgorithmRunnerSubscriber *subscriber) override
Public Member Functions inherited from MantidQt::API::IAlgorithmRunner
virtual	~IAlgorithmRunner ()=default
Public Member Functions inherited from MantidQt::API::JobRunnerSubscriber
virtual	~JobRunnerSubscriber ()=default

Private Attributes
std::unique_ptr< IJobRunner >	m_jobRunner
IConfiguredAlgorithm_sptr	m_lastAlgorithm
IAlgorithmRunnerSubscriber *	m_subscriber

Detailed Description

Definition at line 31 of file AlgorithmRunner.h.

Constructor & Destructor Documentation

AlgorithmRunner()

MantidQt::API::AlgorithmRunner::AlgorithmRunner

(

std::unique_ptr< IJobRunner >

jobRunner

)

Definition at line 13 of file AlgorithmRunner.cpp.

References m_jobRunner.

Member Function Documentation

execute() [1/2]

void MantidQt::API::AlgorithmRunner::execute ( IConfiguredAlgorithm_sptr  algorithm )

overridevirtual

Implements MantidQt::API::IAlgorithmRunner.

Definition at line 20 of file AlgorithmRunner.cpp.

References m_jobRunner.

execute() [2/2]

void MantidQt::API::AlgorithmRunner::execute ( std::deque< IConfiguredAlgorithm_sptr >  algorithmQueue )

overridevirtual

Implements MantidQt::API::IAlgorithmRunner.

Definition at line 24 of file AlgorithmRunner.cpp.

References m_jobRunner.

notifyAlgorithmComplete()

void MantidQt::API::AlgorithmRunner::notifyAlgorithmComplete ( IConfiguredAlgorithm_sptr &  algorithm )

overridevirtual

Implements MantidQt::API::JobRunnerSubscriber.

Definition at line 37 of file AlgorithmRunner.cpp.

References m_lastAlgorithm, m_subscriber, and MantidQt::API::IAlgorithmRunnerSubscriber::notifyAlgorithmComplete().

notifyAlgorithmError()

void MantidQt::API::AlgorithmRunner::notifyAlgorithmError ( IConfiguredAlgorithm_sptr &  algorithm, std::string const &  message  )

overridevirtual

Implements MantidQt::API::JobRunnerSubscriber.

Definition at line 42 of file AlgorithmRunner.cpp.

References m_lastAlgorithm, m_subscriber, and MantidQt::API::IAlgorithmRunnerSubscriber::notifyAlgorithmError().

notifyAlgorithmStarted()

void MantidQt::API::AlgorithmRunner::notifyAlgorithmStarted ( IConfiguredAlgorithm_sptr &  algorithm )

overridevirtual

Implements MantidQt::API::JobRunnerSubscriber.

Definition at line 33 of file AlgorithmRunner.cpp.

References m_subscriber, and MantidQt::API::IAlgorithmRunnerSubscriber::notifyAlgorithmStarted().

notifyBatchCancelled()

void MantidQt::API::AlgorithmRunner::notifyBatchCancelled ( )

overridevirtual

Implements MantidQt::API::JobRunnerSubscriber.

Definition at line 31 of file AlgorithmRunner.cpp.

References m_subscriber, and MantidQt::API::IAlgorithmRunnerSubscriber::notifyBatchCancelled().

notifyBatchComplete()

void MantidQt::API::AlgorithmRunner::notifyBatchComplete ( bool  error )

overridevirtual

Implements MantidQt::API::JobRunnerSubscriber.

Definition at line 29 of file AlgorithmRunner.cpp.

References error, m_lastAlgorithm, m_subscriber, and MantidQt::API::IAlgorithmRunnerSubscriber::notifyBatchComplete().

subscribe()

void MantidQt::API::AlgorithmRunner::subscribe ( IAlgorithmRunnerSubscriber *  subscriber )

overridevirtual

Implements MantidQt::API::IAlgorithmRunner.

Definition at line 18 of file AlgorithmRunner.cpp.

References m_subscriber.

Member Data Documentation

m_jobRunner

std::unique_ptr<IJobRunner> MantidQt::API::AlgorithmRunner::m_jobRunner

private

Definition at line 48 of file AlgorithmRunner.h.

Referenced by AlgorithmRunner(), execute(), and execute().

m_lastAlgorithm

IConfiguredAlgorithm_sptr MantidQt::API::AlgorithmRunner::m_lastAlgorithm

private

Definition at line 51 of file AlgorithmRunner.h.

Referenced by notifyAlgorithmComplete(), notifyAlgorithmError(), and notifyBatchComplete().

m_subscriber

IAlgorithmRunnerSubscriber* MantidQt::API::AlgorithmRunner::m_subscriber

private

Definition at line 49 of file AlgorithmRunner.h.

Referenced by notifyAlgorithmComplete(), notifyAlgorithmError(), notifyAlgorithmStarted(), notifyBatchCancelled(), notifyBatchComplete(), and subscribe().

---

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

• qt/widgets/common/inc/MantidQtWidgets/Common/AlgorithmRunner.h
• qt/widgets/common/src/AlgorithmRunner.cpp