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

#include <Algorithm.h>

Inheritance diagram for Mantid::API::Algorithm::ProgressNotification:

Public Member Functions
std::string	name () const override

	ProgressNotification (const Algorithm *const alg, double p, std::string msg, double estimatedTime, int progressPrecision)
	Constructor.

Public Member Functions inherited from Mantid::API::Algorithm::AlgorithmNotification
const IAlgorithm *	algorithm () const

	AlgorithmNotification (const Algorithm *const alg)

Public Attributes
double	estimatedTime
	Estimated time to completion.

std::string	message
	Message sent with notification.

double	progress
	Current progress. Value must be between 0 and 1.

int	progressPrecision
	Digits of precision to the progress (after the decimal).

Detailed Description

An algorithm can report its progress by sending ProgressNotification.

Use Algorithm::progress(double) function to send a progress notification.

Definition at line 106 of file Algorithm.h.

Constructor & Destructor Documentation

◆ ProgressNotification()

Mantid::API::Algorithm::ProgressNotification::ProgressNotification	(	const Algorithm *const	alg,
		double	p,
		std::string	msg,
		double	estimatedTime,
		int	progressPrecision
	)

Constructor.

Definition at line 1783 of file Algorithm.cpp.

Member Function Documentation

◆ name()

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

override

Definition at line 1788 of file Algorithm.cpp.

Member Data Documentation

◆ estimatedTime

double Mantid::API::Algorithm::ProgressNotification::estimatedTime

Estimated time to completion.

Definition at line 114 of file Algorithm.h.

◆ message

std::string Mantid::API::Algorithm::ProgressNotification::message

Message sent with notification.

Definition at line 113 of file Algorithm.h.

◆ progress

double Mantid::API::Algorithm::ProgressNotification::progress

Current progress. Value must be between 0 and 1.

Definition at line 112 of file Algorithm.h.

◆ progressPrecision

int Mantid::API::Algorithm::ProgressNotification::progressPrecision

Digits of precision to the progress (after the decimal).

Definition at line 115 of file Algorithm.h.

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

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

Public Member Functions

Public Attributes