casacore
LatticeHistProgress.h
Go to the documentation of this file.
1//# LatticeHistProgress.h: progress meter for LatticeHistograms
2//# Copyright (C) 1996,1997,1999,2000
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: aips2-request@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25//#
26//# $Id$
27
28#ifndef LATTICES_LATTICEHISTPROGRESS_H
29#define LATTICES_LATTICEHISTPROGRESS_H
30
31
32//# Includes
33#include <casacore/casa/aips.h>
34#include <casacore/lattices/LatticeMath/LatticeProgress.h>
35namespace casacore { //# NAMESPACE CASACORE - BEGIN
36
37class ProgressMeter;
38
39
40// <summary> Provides a progress meter for the <src>LatticeHistograms</src> class </summary>
41// <use visibility=export>
42//
43// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
44// </reviewed>
45//
46// <prerequisite>
47// <li> <linkto module=Lattices>LatticeProgress</linkto>
48// </prerequisite>
49//
50// <etymology>
51// Display a progress meter for the class <src>LatticeHistograms</src>
52// </etymology>
53//
54// <synopsis>
55// Progress meters can be displayed by the <src>LatticeApply</src> class
56// which is used by <src>LatticeHistograms</src> in order to optimally iterate
57// through the image. To do this, one must derive a
58// class from <src>LatticeProgress</src>. <src>LatticeApply</src> calls
59// methods declared in <src>LatticeProgress</src> and implemented in
60// the derived class.
61// </synopsis>
62//
63// <motivation>
64// I like progress meters !
65// </motivation>
66//
67// <todo asof="1998/01/10">
68// </todo>
71{
72public:
73
74// Constructor makes a null object
76
77// Destructor deletes the ProgressMeter pointer
78 virtual ~LatticeHistProgress();
79
80// Initialize this object. Here we create the ProgressMeter
81// This function is called by the <src>init</src> in LatticeProgress
82 virtual void initDerived();
83
84// Tell the number of steps done so far.
85 virtual void nstepsDone (uInt nsteps);
86
87// The process has ended so clean things up.
88 virtual void done();
89
90private:
92};
93
94
95
96} //# NAMESPACE CASACORE - END
97
98#endif
99
100
101
Provides a progress meter for the LatticeHistograms class.
virtual void nstepsDone(uInt nsteps)
Tell the number of steps done so far.
LatticeHistProgress()
Constructor makes a null object.
virtual void initDerived()
Initialize this object.
virtual void done()
The process has ended so clean things up.
virtual ~LatticeHistProgress()
Destructor deletes the ProgressMeter pointer.
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51