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. | |
virtual bool | isPercent () const |
Determines if the state of progress can be expressed as a percentage. | |
![]() | |
NProgress () | |
Performs basic initialisation. | |
virtual | ~NProgress () |
Destroys this object. | |
bool | hasChanged () const |
Determines if the state of progress has changed since the last query. | |
bool | isFinished () const |
Is the operation whose progress we are reporting completely finished? | |
void | setFinished () |
Signifies that the operation whose progress we are reporting is completely finished. | |
void | cancel () const |
Called by an external interface to request that the operation whose progress we are reporting be cancelled. | |
bool | isCancelled () const |
Determines whether an external interface has requested that the operation whose progress we are reporting be cancelled. | |
std::string | getDescription () const |
Returns a string description of the current state of progress. | |
double | getPercent () const |
Returns the current state of progress as a percentage. | |
long | getRealTime () const |
Returns the real time elapsed since this operation began. | |
long | totalCPUTime () const |
Returns the total CPU time consumed by the program from the beginning to the end of this operation. | |
void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. | |
![]() | |
ShareableObject () | |
Default constructor that does nothing. | |
virtual | ~ShareableObject () |
Default destructor that does nothing. | |
virtual void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. | |
std::string | toString () const |
Returns the output from writeTextShort() as a string. | |
std::string | toStringLong () const |
Returns the output from writeTextLong() as a string. |
Protected Member Functions | |
virtual std::string | internalGetDescription () const |
Returns a string description of the current state of progress. | |
virtual double | internalGetPercent () const |
Returns the current state of progress as a percentage. |
Additional Inherited Members | |
![]() | |
bool | changed |
Has the state of progress changed since the last query? |
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.
Implements regina::NProgress.
|
inlineprotectedvirtual |
Returns the current state of progress as a percentage.
The default implementation returns 0.
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.