#include <MockAlgorithmRunner.h>

Inheritance diagram for MockAlgorithmRunner:

Public Member Functions
Mantid::API::IAlgorithm_sptr	algorithm () const

	MOCK_CONST_METHOD0 (getAlgorithm, Mantid::API::IAlgorithm_sptr())

	MOCK_METHOD0 (cancelRunningAlgorithm, void())

	MOCK_METHOD1 (startAlgorithmImpl, void(Mantid::API::IAlgorithm_sptr))

	MockAlgorithmRunner ()=default

void	startAlgorithm (Mantid::API::IAlgorithm_sptr alg)
	Begin asynchronous execution of an algorithm and observe its execution. More...

Public Member Functions inherited from MantidQt::API::AlgorithmRunner
	AlgorithmRunner (QObject *parent=nullptr)
	Constructor. More...

virtual void	cancelRunningAlgorithm ()
	If an algorithm is already running, cancel it. More...

virtual Mantid::API::IAlgorithm_sptr	getAlgorithm () const
	Get back a pointer to the running algorithm. More...

virtual void	startAlgorithm (Mantid::API::IAlgorithm_sptr alg)
	Begin asynchronous execution of an algorithm and observe its execution. More...

	~AlgorithmRunner () override
	Destructor. More...

Private Attributes
Mantid::API::IAlgorithm_sptr	m_algorithm

Additional Inherited Members
Signals inherited from MantidQt::API::AlgorithmRunner
void	algorithmComplete (bool error)
	Signal emitted when the algorithm has completed execution/encountered an error. More...

void	algorithmProgress (double p, const std::string &msg)
	Signal emitted when the algorithm reports progress. More...

Protected Member Functions inherited from MantidQt::API::AlgorithmRunner
void	handleAlgorithmErrorNotification (const Poco::AutoPtr< Mantid::API::Algorithm::ErrorNotification > &pNf)
	Observer called when the async algorithm has encountered an error. More...

void	handleAlgorithmFinishedNotification (const Poco::AutoPtr< Mantid::API::Algorithm::FinishedNotification > &pNf)
	Algorithm notification handlers. More...

void	handleAlgorithmProgressNotification (const Poco::AutoPtr< Mantid::API::Algorithm::ProgressNotification > &pNf)
	Observer called when the async algorithm has progress to report. More...

Protected Attributes inherited from MantidQt::API::AlgorithmRunner
Mantid::API::IAlgorithm_sptr	m_asyncAlg
	Reference to the algorithm executing asynchronously. More...

Poco::ActiveResult< bool > *	m_asyncResult
	For the asynchronous call in dynamic rebinning. More...

Poco::NObserver< AlgorithmRunner, Mantid::API::Algorithm::ErrorNotification >	m_errorObserver

Poco::NObserver< AlgorithmRunner, Mantid::API::Algorithm::FinishedNotification >	m_finishedObserver

Poco::NObserver< AlgorithmRunner, Mantid::API::Algorithm::ProgressNotification >	m_progressObserver

Detailed Description

Definition at line 19 of file MockAlgorithmRunner.h.

Constructor & Destructor Documentation

◆ MockAlgorithmRunner()

MockAlgorithmRunner::MockAlgorithmRunner ( )

default

Member Function Documentation

◆ algorithm()

Mantid::API::IAlgorithm_sptr MockAlgorithmRunner::algorithm ( ) const

inline

Definition at line 33 of file MockAlgorithmRunner.h.

References m_algorithm.

◆ MOCK_CONST_METHOD0()

MockAlgorithmRunner::MOCK_CONST_METHOD0	(	getAlgorithm	,
		Mantid::API::IAlgorithm_sptr()
	)

◆ MOCK_METHOD0()

MockAlgorithmRunner::MOCK_METHOD0	(	cancelRunningAlgorithm	,
		void()
	)

◆ MOCK_METHOD1()

MockAlgorithmRunner::MOCK_METHOD1	(	startAlgorithmImpl	,
		void(Mantid::API::IAlgorithm_sptr)
	)

◆ startAlgorithm()

void MockAlgorithmRunner::startAlgorithm ( Mantid::API::IAlgorithm_sptr alg )

inlinevirtual

Begin asynchronous execution of an algorithm and observe its execution.

Parameters

alg	:: algorithm to execute. All properties should have been set properly.

Reimplemented from MantidQt::API::AlgorithmRunner.

Definition at line 28 of file MockAlgorithmRunner.h.

References m_algorithm.

Member Data Documentation

◆ m_algorithm

Mantid::API::IAlgorithm_sptr MockAlgorithmRunner::m_algorithm

private

Definition at line 36 of file MockAlgorithmRunner.h.

Referenced by algorithm(), and startAlgorithm().

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

qt/widgets/common/inc/MantidQtWidgets/Common/MockAlgorithmRunner.h

Public Member Functions

Private Attributes

Additional Inherited Members