Regina Calculation Engine
|
A progress report that immediately claims it is finished. More...
#include <progress/nprogress.h>
Public Member Functions | |
NProgressFinished () | |
Creates a new finished progress report. More... | |
virtual bool | isPercent () const |
Determines if the state of progress can be expressed as a percentage. More... | |
![]() | |
NProgress () | |
Performs basic initialisation. More... | |
virtual | ~NProgress () |
Destroys this object. More... | |
bool | hasChanged () const |
Determines if the state of progress has changed since the last query. More... | |
bool | isFinished () const |
Is the operation whose progress we are reporting completely finished? More... | |
void | setFinished () |
Signifies that the operation whose progress we are reporting is completely finished. More... | |
void | cancel () const |
Called by an external interface to request that the operation whose progress we are reporting be cancelled. More... | |
bool | isCancelled () const |
Determines whether an external interface has requested that the operation whose progress we are reporting be cancelled. More... | |
std::string | getDescription () const |
Returns a string description of the current state of progress. More... | |
double | getPercent () const |
Returns the current state of progress as a percentage. More... | |
long | getRealTime () const |
Returns the real time elapsed since this operation began. More... | |
long | totalCPUTime () const |
Returns the total CPU time consumed by the program from the beginning to the end of this operation. More... | |
void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. More... | |
![]() | |
ShareableObject () | |
Default constructor that does nothing. More... | |
virtual | ~ShareableObject () |
Default destructor that does nothing. More... | |
virtual void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. More... | |
std::string | str () const |
Returns the output from writeTextShort() as a string. More... | |
std::string | toString () const |
A deprecated alias for str(), which returns the output from writeTextShort() as a string. More... | |
std::string | detail () const |
Returns the output from writeTextLong() as a string. More... | |
std::string | toStringLong () const |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More... | |
Protected Member Functions | |
virtual std::string | internalGetDescription () const |
Returns a string description of the current state of progress. More... | |
virtual double | internalGetPercent () const |
Returns the current state of progress as a percentage. More... | |
![]() | |
noncopyable () | |
A constructor which does nothing. More... | |
~noncopyable () | |
A destructor which does nothing. More... | |
![]() | |
NMutex () | |
Creates a new mutex. More... | |
~NMutex () | |
Destroys this mutex. More... | |
Additional Inherited Members | |
![]() | |
bool | changed |
Has the state of progress changed since the last query? More... | |
bool | cancelled |
Has this operation been cancelled? More... | |
A progress report that immediately claims it is finished.
There is no need to call setFinished(); this will be done automatically by the constructor.
|
inline |
Creates a new finished progress report.
This constructor will automatically call setFinished().
|
inlineprotectedvirtual |
Returns a string description of the current state of progress.
This function must not touch the mutex, and is not required to alter the changed flag. The getDescription() routine takes care of all of these issues.
Implements regina::NProgress.
|
inlineprotectedvirtual |
Returns the current state of progress as a percentage.
The default implementation returns 0.
This function must not touch the mutex, and is not required to alter the changed flag. The getDescription() routine takes care of all of these issues.
Reimplemented from regina::NProgress.
|
inlinevirtual |
Determines if the state of progress can be expressed as a percentage.
The default implementation returns false
.
true
if and only if progress can be expressed as a percentage. Reimplemented from regina::NProgress.