Mantid
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Mantid::API::Algorithm::ProgressNotification Class Reference

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

#include <Algorithm.h>

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

Public Member Functions

std::string name () const override
 
 ProgressNotification (const Algorithm *const alg, double p, std::string msg, double estimatedTime, int progressPrecision)
 Constructor. More...
 
- Public Member Functions inherited from Mantid::API::Algorithm::AlgorithmNotification
const IAlgorithmalgorithm () const
 
 AlgorithmNotification (const Algorithm *const alg)
 

Public Attributes

double estimatedTime
 Estimated time to completion. More...
 
std::string message
 Message sent with notification. More...
 
double progress
 Current progress. Value must be between 0 and 1. More...
 
int progressPrecision
 Digits of precision to the progress (after the decimal). More...
 

Detailed Description

An algorithm can report its progress by sending ProgressNotification.

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

Definition at line 115 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 1893 of file Algorithm.cpp.

Member Function Documentation

◆ name()

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

Definition at line 1898 of file Algorithm.cpp.

Member Data Documentation

◆ estimatedTime

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

Estimated time to completion.

Definition at line 123 of file Algorithm.h.

◆ message

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

Message sent with notification.

Definition at line 122 of file Algorithm.h.

◆ progress

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

Current progress. Value must be between 0 and 1.

Definition at line 121 of file Algorithm.h.

◆ progressPrecision

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

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

Definition at line 124 of file Algorithm.h.


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