#include <nprogresstypes.h>
Inheritance diagram for regina::NProgressNumber:
Public Member Functions | |
NProgressNumber (long newCompleted=0, long newOutOf=-1) | |
Creates a new progress report containing the given details. | |
long | getCompleted () const |
Returns the number of items completed. | |
long | getOutOf () const |
Returns the expected total number of items. | |
NProgressStateNumeric | getNumericState () const |
Returns both the number of items completed and the expected total number of items. | |
void | setCompleted (long newCompleted) |
Sets the number of items completed. | |
void | incCompleted (unsigned long extraCompleted=1) |
Increases the number of items completed by the given amount. | |
void | setOutOf (long newOutOf) |
Sets the expected total number of items. | |
virtual bool | isPercent () const |
Determines if the state of progress can be expressed as a percentage. | |
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. |
The expected total number of items can be optionally specified.
|
Creates a new progress report containing the given details. Note that the internal mutex is not locked during construction.
|
|
Returns the number of items completed.
|
|
Returns both the number of items completed and the expected total number of items.
|
|
Returns the expected total number of items.
|
|
Increases the number of items completed by the given amount.
|
|
Returns a string description of the current state of progress.
Implements regina::NProgress. |
|
Returns the current state of progress as a percentage. The default implementation returns 0.
Reimplemented from regina::NProgress. |
|
Determines if the state of progress can be expressed as a percentage.
The default implementation returns
Reimplemented from regina::NProgress. |
|
Sets the number of items completed.
|
|
Sets the expected total number of items.
|