Progress¶

This is a Python binding to the C++ class Mantid::API::Progress.

bases: mantid.kernel.ProgressBase

class mantid.api.Progress¶

Make a Progress object that is attached to the given algorithm, with progress between fractions [start,end] notifying a total of nreports times

getEstimatedTime((ProgressBase)self) → float :¶

Returns an estimate of the time remaining. May not be to accurate if the reporting is lumpy.

report((ProgressBase)self) → None :¶

Increment the progress by 1 and report with no message

report( (ProgressBase)self, (str)msg) -> None :

Increment the progress by 1 and report along with the given message

report( (ProgressBase)self, (int)i, (str)msg) -> None :

Set the progress to given amount and report along with the given message

reportIncrement((ProgressBase)self, (int)i, (str)msg) → None :¶

Increment the progress by given amount and report along with the given message

resetNumSteps((ProgressBase)self, (int)nsteps, (float)start, (float)end) → None :¶

Resets the number of steps & progress range to the given values

setNotifyStep((ProgressBase)self, (float)notifyStep) → None :¶

Set how often the notifications are actually reported

setNumSteps((ProgressBase)self, (int)nsteps) → None :¶

Sets a new number of steps for the current progress range