Regina Calculation Engine
Public Member Functions | Protected Member Functions | List of all members
regina::NProgressFinished Class Reference

A progress report that immediately claims it is finished. More...

#include <progress/nprogress.h>

Inheritance diagram for regina::NProgressFinished:
regina::NProgress regina::ShareableObject regina::NMutex regina::boost::noncopyable

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...
 
- Public Member Functions inherited from regina::NProgress
 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...
 
- Public Member Functions inherited from regina::ShareableObject
 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 toString () const
 Returns the output from writeTextShort() as a string. More...
 
std::string toStringLong () const
 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...
 

Additional Inherited Members

- Protected Attributes inherited from regina::NProgress
bool changed
 Has the state of progress changed since the last query? More...
 

Detailed Description

A progress report that immediately claims it is finished.

There is no need to call setFinished(); this will be done automatically by the constructor.

Python:
Not present; all progress classes communicate with external interfaces through the NProgress interface.

Constructor & Destructor Documentation

regina::NProgressFinished::NProgressFinished ( )
inline

Creates a new finished progress report.

This constructor will automatically call setFinished().

Member Function Documentation

std::string regina::NProgressFinished::internalGetDescription ( ) const
inlineprotectedvirtual

Returns a string description of the current state of progress.

Returns
the current state of progress.

Implements regina::NProgress.

double regina::NProgressFinished::internalGetPercent ( ) const
inlineprotectedvirtual

Returns the current state of progress as a percentage.

The default implementation returns 0.

Precondition
Progress can be expressed as a percentage (see isPercent()).
Returns
the current state of progress as a percentage.

Reimplemented from regina::NProgress.

bool regina::NProgressFinished::isPercent ( ) const
inlinevirtual

Determines if the state of progress can be expressed as a percentage.

The default implementation returns false.

Returns
true if and only if progress can be expressed as a percentage.

Reimplemented from regina::NProgress.


The documentation for this class was generated from the following file:

Copyright © 1999-2012, The Regina development team
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).