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

#include <Algorithm.h>

Inheritance diagram for Mantid::API::Algorithm::CancelException:

Public Member Functions
const char *	what () const noexcept override
	Returns the message string. More...

Detailed Description

CancelException is thrown to cancel execution of the algorithm.

Use Algorithm::cancel() to terminate an algorithm. The execution will only be stopped if Algorithm::exec() method calls periodically Algorithm::interuption_point() which checks if Algorithm::cancel() has been called and throws CancelException if needed.

Definition at line 145 of file Algorithm.h.

Member Function Documentation

const char * Mantid::API::Algorithm::CancelException::what ( ) const

overridenoexcept

Returns the message string.

Definition at line 1905 of file Algorithm.cpp.

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