Regina Calculation Engine
Public Member Functions | Protected Member Functions
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

List of all members.

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.

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.

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 [inline, protected, virtual]

Returns a string description of the current state of progress.

Returns:
the current state of progress.

Implements regina::NProgress.

double regina::NProgressFinished::internalGetPercent ( ) const [inline, protected, virtual]

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 [inline, virtual]

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-2011, 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).