casacore::LattStatsProgress Class Reference

Provides a progress meter for the LatticeStatistics class. More...

#include <LattStatsProgress.h>

Inheritance diagram for casacore::LattStatsProgress:

Public Member Functions
	LattStatsProgress ()
	Constructor makes a null object. More...
virtual	~LattStatsProgress ()
	Destructor deletes the ProgressMeter pointer. More...
void	operator++ (Int)
	increment the current step (postfix version) More...
virtual void	initDerived ()
	Initialize this object. More...
virtual void	nstepsDone (uInt nsteps)
	Tell the number of steps done so far. More...
virtual void	done ()
	The process has ended so clean things up. More...
Public Member Functions inherited from casacore::LatticeProgress
	LatticeProgress ()
virtual	~LatticeProgress ()
void	init (uInt expectedNsteps)
	Initialize the process. More...
uInt	expectedNsteps () const
	Recovers the expected number of total steps. More...

Private Attributes
CountedPtr< ProgressMeter >	_meter
uInt	_currentStep

Additional Inherited Members

Detailed Description

Provides a progress meter for the LatticeStatistics class.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• LatticeProgress

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 !

Definition at line 71 of file LattStatsProgress.h.

Constructor & Destructor Documentation

casacore::LattStatsProgress::LattStatsProgress ( )

inline

Constructor makes a null object.

Definition at line 76 of file LattStatsProgress.h.

virtual casacore::LattStatsProgress::~LattStatsProgress ( )

virtual

Destructor deletes the ProgressMeter pointer.

Member Function Documentation

virtual void casacore::LattStatsProgress::done ( )

virtual

The process has ended so clean things up.

Reimplemented from casacore::LatticeProgress.

virtual void casacore::LattStatsProgress::initDerived ( )

virtual

Initialize this object.

Here we create the ProgressMeter This function is called by the init in LatticeProgress

Reimplemented from casacore::LatticeProgress.

virtual void casacore::LattStatsProgress::nstepsDone ( uInt  nsteps )

virtual

Tell the number of steps done so far.

Reimplemented from casacore::LatticeProgress.

void casacore::LattStatsProgress::operator++

(

Int

)

increment the current step (postfix version)

Member Data Documentation

uInt casacore::LattStatsProgress::_currentStep

private

Definition at line 96 of file LattStatsProgress.h.

CountedPtr<ProgressMeter> casacore::LattStatsProgress::_meter

private

Definition at line 95 of file LattStatsProgress.h.

---

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

• casa/casacore/lattices/LatticeMath/LattStatsProgress.h