Regina Calculation Engine
|
Classes | |
class | regina::ProgressTrackerBase |
The base class for Regina's progress tracking classes. More... | |
class | regina::ProgressTracker |
Manages percentage-based progress tracking and cancellation polling for long operations. More... | |
class | regina::ProgressTrackerOpen |
Manages percentage-based progress tracking and cancellation polling for open-ended operations. More... | |
Typedefs | |
typedef ProgressTrackerBase | regina::NProgressTrackerBase |
Deprecated typedef for backward compatibility. More... | |
typedef ProgressTracker | regina::NProgressTracker |
Deprecated typedef for backward compatibility. More... | |
typedef ProgressTrackerOpen | regina::NProgressTrackerOpen |
Deprecated typedef for backward compatibility. More... | |
Functions | |
bool | regina::ProgressTrackerBase::isFinished () |
Queries whether the writing thread has finished all processing. More... | |
bool | regina::ProgressTrackerBase::descriptionChanged () |
Queries whether the stage description has changed since the last call to descriptionChanged(). More... | |
std::string | regina::ProgressTrackerBase::description () |
Returns the human-readable description of the current stage. More... | |
void | regina::ProgressTrackerBase::cancel () |
Indicates to the writing thread that the user wishes to cancel the operation. More... | |
bool | regina::ProgressTrackerBase::isCancelled () |
Queries whether the reading thread has made a request for the writing thread to cancel the operation; in other words, whether cancel() has been called. More... | |
void | regina::ProgressTrackerBase::setFinished () |
Used by the writing thread to indicate that it has finished all processing. More... | |
regina::ProgressTrackerBase::ProgressTrackerBase () | |
Creates a new progress tracker. More... | |
regina::ProgressTracker::ProgressTracker () | |
Creates a new progress tracker. More... | |
bool | regina::ProgressTracker::percentChanged () |
Queries whether the percentage progress has changed since the last call to percentChanged(). More... | |
double | regina::ProgressTracker::percent () |
Returns the percentage progress through the entire operation. More... | |
void | regina::ProgressTracker::newStage (const char *desc, double weight=1) |
Used by the writing thread to indicate that it has moved on to a new stage of processing. More... | |
void | regina::ProgressTracker::newStage (const std::string &desc, double weight=1) |
Used by the writing thread to indicate that it has moved on to a new stage of processing. More... | |
bool | regina::ProgressTracker::setPercent (double percent) |
Used by the writing thread to indicate the level of progress through the current stage. More... | |
void | regina::ProgressTracker::setFinished () |
Used by the writing thread to indicate that it has finished all processing. More... | |
regina::ProgressTrackerOpen::ProgressTrackerOpen () | |
Creates a new progress tracker. More... | |
bool | regina::ProgressTrackerOpen::stepsChanged () |
Queries whether the number of steps completed has changed since the last call to stepsChanged(). More... | |
unsigned long | regina::ProgressTrackerOpen::steps () |
Returns the number of steps completed throughout the entire operation. More... | |
void | regina::ProgressTrackerOpen::newStage (const char *desc) |
Used by the writing thread to indicate that it has moved on to a new stage of processing. More... | |
void | regina::ProgressTrackerOpen::newStage (const std::string &desc) |
Used by the writing thread to indicate that it has moved on to a new stage of processing. More... | |
bool | regina::ProgressTrackerOpen::incSteps () |
Used by the writing thread to indicate that one more step has been completed. More... | |
bool | regina::ProgressTrackerOpen::incSteps (unsigned long add) |
Used by the writing thread to indicate that some number of additional steps have been completed. More... | |
void | regina::ProgressTrackerOpen::setFinished () |
Used by the writing thread to indicate that it has finished all processing. More... | |
Variables | |
std::string | regina::ProgressTrackerBase::desc_ |
The human-readable description of the current stage. More... | |
bool | regina::ProgressTrackerBase::descChanged_ |
Has the description changed since the last call to descriptionChanged()? More... | |
bool | regina::ProgressTrackerBase::cancelled_ |
Has the reading thread requested that the operation be cancelled? More... | |
bool | regina::ProgressTrackerBase::finished_ |
Has the writing thread declared that it has finished all processing? More... | |
std::mutex | regina::ProgressTrackerBase::lock_ |
A mutex to stop the reading and writing threads from interfering with each other. More... | |
Progress tracking for long operations
Deprecated typedef for backward compatibility.
This typedef will be removed in a future release of Regina.
Deprecated typedef for backward compatibility.
This typedef will be removed in a future release of Regina.
Deprecated typedef for backward compatibility.
This typedef will be removed in a future release of Regina.
|
inline |
Indicates to the writing thread that the user wishes to cancel the operation.
The writing thread might not detect and/or respond to this request immediately (or indeed ever), and so the reading thread should continue to wait until isFinished() returns true
before it cleans up and destroys this progress tracker.
This is typically called by the reading thread.
|
inline |
Returns the human-readable description of the current stage.
This is typically called by the reading thread.
the
current stage description.
|
inline |
Queries whether the stage description has changed since the last call to descriptionChanged().
If this is the first time descriptionChanged() is called, the result will be true
.
This is typically called by the reading thread.
true
if and only if the stage description has changed.
|
inline |
Used by the writing thread to indicate that one more step has been completed.
This is typically called by the writing thread.
true
if there has been no cancellation request, or false
if cancel() has been called (typically by the reading thread).
|
inline |
Used by the writing thread to indicate that some number of additional steps have been completed.
This is typically called by the writing thread.
add | the number of additional steps that have been completed. The value returned by steps() will increase by this amount. |
true
if there has been no cancellation request, or false
if cancel() has been called (typically by the reading thread).
|
inline |
Queries whether the reading thread has made a request for the writing thread to cancel the operation; in other words, whether cancel() has been called.
This is typically called by the writing thread.
true
if and only if a cancellation request has been made.
|
inline |
Queries whether the writing thread has finished all processing.
This will eventually return true
regardless of whether the processing finished naturally or was cancelled by the reading thread.
This is typically called by the reading thread.
true
if and only if the writing thread has finished all processing.
|
inline |
Used by the writing thread to indicate that it has moved on to a new stage of processing.
The number of steps completed will be left unchanged.
This is typically called by the writing thread.
desc | a human-readable description of the new stage. Typically this begins with a capital and does not include a final period (full stop). |
|
inline |
Used by the writing thread to indicate that it has moved on to a new stage of processing.
The percentage progress through the current stage will automatically be set to 100.
This is typically called by the writing thread.
desc | a human-readable description of the new stage. Typically this begins with a capital and does not include a final period (full stop). |
weight | the relative weight of this stage as a fraction of the entire operation. This weight must be between 0 and 1 inclusive, and the weights of all stages must sum to 1 in total. |
|
inline |
Used by the writing thread to indicate that it has moved on to a new stage of processing.
The number of steps completed will be left unchanged.
This is typically called by the writing thread.
desc | a human-readable description of the new stage. Typically this begins with a capital and does not include a final period (full stop). |
|
inline |
Used by the writing thread to indicate that it has moved on to a new stage of processing.
The percentage progress through the current stage will automatically be set to 100.
This is typically called by the writing thread.
desc | a human-readable description of the new stage. Typically this begins with a capital and does not include a final period (full stop). |
weight | the relative weight of this stage as a fraction of the entire operation. This weight must be between 0 and 1 inclusive, and the weights of all stages must sum to 1 in total. |
|
inline |
Returns the percentage progress through the entire operation.
This combines the progress through the current stage with all previous stages, taking into account the relative weights that the writing thread has passed to newStage().
This is typically called by the reading thread.
|
inline |
Queries whether the percentage progress has changed since the last call to percentChanged().
If this is the first time percentChanged() is called, the result will be true
.
This is typically called by the reading thread.
true
if and only if the percentage progress has changed.
|
inline |
Creates a new progress tracker.
This sets a sensible state description (which declares that the operation is initialising), and marks the current progress as zero percent complete.
This is typically called by the reading thread.
|
inlineprotected |
Creates a new progress tracker.
This sets a sensible state description (which declares that the operation is initialising).
This is only ever called by subclass constructors.
|
inline |
Creates a new progress tracker.
This sets a sensible state description (which declares that the operation is initialising), and marks the current progress as zero steps completed.
This is typically called by the reading thread.
void regina::ProgressTrackerBase::setFinished | ( | ) |
Used by the writing thread to indicate that it has finished all processing.
The stage description will be updated to indicate that the operation is finished.
This is typically called by the writing thread.
|
inline |
Used by the writing thread to indicate that it has finished all processing.
The percentage progress through both the current stage and the entire operation will automatically be set to 100, and the stage description will be updated to indicate that the operation is finished.
This is typically called by the writing thread.
|
inline |
Used by the writing thread to indicate that it has finished all processing.
The total number of steps completed will be left unchanged, but the stage description will be updated to indicate that the operation is finished.
This is typically called by the writing thread.
|
inline |
Used by the writing thread to indicate the level of progress through the current stage.
Unlike percent(), which measures progress in the context of the entire operation, this routine takes a percentage that is strictly relative to the current stage (i.e., the stage most recently declared through a call to newStage()). When the stage begins, setPercent() would typically be given a figure close to 0; when the stage is finished, setPercent() would typically be given a figure close to 100.
There is no actual need to call setPercent(0) at the beginning of the stage or setPercent(100) at the end of the stage, since other routines (such as the constructor, newStage() and setFinished()) will take care of this for you.
This is typically called by the writing thread.
percent | the percentage progress through this stage, as a number between 0 and 100 inclusive. |
true
if there has been no cancellation request, or false
if cancel() has been called (typically by the reading thread).
|
inline |
Returns the number of steps completed throughout the entire operation.
This counts the progress across all stages (both current and previous).
This is typically called by the reading thread.
|
inline |
Queries whether the number of steps completed has changed since the last call to stepsChanged().
If this is the first time stepsChanged() is called, the result will be true
.
This is typically called by the reading thread.
true
if and only if the number of steps completed has changed.
|
protected |
Has the reading thread requested that the operation be cancelled?
|
protected |
The human-readable description of the current stage.
|
protected |
Has the description changed since the last call to descriptionChanged()?
|
protected |
Has the writing thread declared that it has finished all processing?
|
protected |
A mutex to stop the reading and writing threads from interfering with each other.