LattStatsProgress.h

Classes

LattStatsProgress -- Provides a progress meter for the LatticeStatistics class (full description)

class LattStatsProgress : public LatticeProgress

Interface

Public Members
LattStatsProgress() : itsMeter(0)
virtual ~LattStatsProgress()
virtual void initDerived()
virtual void nstepsDone (uInt nsteps)
virtual void done()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Display a progress meter for the class LatticeStatistics

Synopsis

Progress meters can be displayed by the LatticeApply class which is used by LatticeStatistics in order to optimally iterate through the lattice. To do this, one must derive a class from LatticeProgress. LatticeApply calls methods declared in LatticeProgress and implemented in the derived class.

Motivation

I like progress meters !

To Do

Member Description

LattStatsProgress() : itsMeter(0)

Constructor makes a null object

virtual ~LattStatsProgress()

Destructor deletes the ProgressMeter pointer

virtual void initDerived()

Initialize this object. Here we create the ProgressMeter This function is called by the init in LatticeProgress

virtual void nstepsDone (uInt nsteps)

Tell the number of steps done so far.

virtual void done()

The process has ended so clean things up.