regina::NProgressFinished Class Reference
[Progress Management]

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

#include <nprogress.h>

Inheritance diagram for regina::NProgressFinished:

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

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.

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.

---

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

• nprogress.h