#include <LatticeProgress.h>
Inheritance diagram for casa::LatticeProgress:
Part of API
This is an abstract base class for classes to monitor the progress of an operation on a Lattice. The default implementation offered by this class does nothing. However, a derived class could show the progress using for example a ProgressMeter . A derived class should override the virtual functions from this class.
The user of the LatticeProgress object should first call function init with the total number of steps that are to be done. Thereafter, after each step has been executed, function nstepsDone should be called after each step. Finally, function done should be called.
Since operations on Lattices can take a while, it can be useful to show the progress. However, making module Lattices dependent on the class ProgressMeter sounded bad. This abstract class serves as a bridge between the Lattice module and the ProgressMeter class (or any other class showing the progress).
Definition at line 84 of file LatticeProgress.h.
Public Member Functions | |
| LatticeProgress () | |
| virtual | ~LatticeProgress () |
| void | init (uInt expectedNsteps) |
| Initialize the process. | |
| virtual void | nstepsDone (uInt nsteps) |
| Tell the number of steps done so far. | |
| virtual void | done () |
| The process has ended. | |
| uInt | expectedNsteps () const |
| Recovers the expected number of total steps. | |
Protected Member Functions | |
| virtual void | initDerived () |
| Let a derived class initialize itself. | |
Private Attributes | |
| uInt | itsExpectedNsteps |
| casa::LatticeProgress::LatticeProgress | ( | ) | [inline] |
Definition at line 87 of file LatticeProgress.h.
| virtual casa::LatticeProgress::~LatticeProgress | ( | ) | [virtual] |
| void casa::LatticeProgress::init | ( | uInt | expectedNsteps | ) |
Initialize the process.
It sets the expected number of steps and calls initDerived, so a derived class can initialize itself.
| virtual void casa::LatticeProgress::nstepsDone | ( | uInt | nsteps | ) | [virtual] |
Tell the number of steps done so far.
The default implementation does nothing. A derived class should call the ProgressMeter function update
| virtual void casa::LatticeProgress::done | ( | ) | [virtual] |
The process has ended.
| uInt casa::LatticeProgress::expectedNsteps | ( | ) | const [inline] |
Recovers the expected number of total steps.
Definition at line 106 of file LatticeProgress.h.
References itsExpectedNsteps.
| virtual void casa::LatticeProgress::initDerived | ( | ) | [protected, virtual] |
Let a derived class initialize itself.
This function is called by init. The derived class should create the ProgressMeter in here.
uInt casa::LatticeProgress::itsExpectedNsteps [private] |
1.5.1