casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
casacore::ProgressMeter Class Reference

Visual indication of a tasks progress. More...

#include <ProgressMeter.h>

Public Member Functions

 ProgressMeter ()
 Makes a null progress meter, i.e. More...
 
 ProgressMeter (Double min, Double max, const String &title, const String &subtitle, const String &minlabel, const String &maxlabel, Bool estimateTime=True, Int updateEvery=1)
 Create a progress meter with the given min and max values and labels. More...
 
 ProgressMeter (Double min, Double max, const String &title)
 
 ~ProgressMeter ()
 The destruction of the meter will cause an update to be sent with the maximum value. More...
 
void update (Double value, Bool force=False)
 
void _update (Double value, Bool force=False)
 
void busy ()
 
void done ()
 
Double min () const
 Display the min and max values of the progress meter. More...
 
Double max () const
 

Static Public Attributes

static const char * PROGRESSFILE
 

Private Member Functions

 ProgressMeter (const ProgressMeter &)
 Undefined and inaccessible. More...
 
ProgressMeteroperator= (const ProgressMeter &)
 

Private Attributes

Int id_p
 
Double min_p
 
Double max_p
 
Int update_every_p
 
Int update_count_p
 
time_t startTime
 Time the progress meter began. More...
 
Bool showProgress
 

Static Private Attributes

static Int(* creation_function_p )(Double, Double, const String &, const String &, const String &, const String &, Bool)
 These are set by ObjectController for executables that have the tasking system in them, otherwise they are null and this class just does no-ops. More...
 
static void(* update_function_p )(Int, Double)
 
static void(* show_function_p )(Int, Double)
 
static void(* busy_function_p )(Int)
 
static void(* done_function_p )(Int)
 

Friends

class ObjectController
 

Detailed Description

Visual indication of a tasks progress.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Synopsis

This class is used to provide a visual indication to the user of the progress of his task. If the process is not connected to the DO system, calls to the progress meter are NO-OP's, so you can safely use this class in general library code and it won't cause problems for processes which are not attached to the distributed object system. It also won't cause any extra stuff to be linked in to your executable in this case.

The progress meter will usually be removed from the screen once the maximum value is set, so you should not reuse the ProgressMeter after that has happened. It is harmless, but it will not result in any visual feedback for the user.

While the "min" is usually less than "max", if in fact it is greater than "max" the progress meter will count down correctly.

Example

void calculate(uInt n) {
Int skip = n / 200;
ProgressMeter meter(0, n, "Title", "Subtitle", "", "", True, skip);
for (uInt i=0; i<n; i++) {
... calculate..\.
meter.update(i);
}
}

Motivation

Give the user visual indication of a long-running tasks progress.

To Do

Definition at line 91 of file ProgressMeter.h.

Constructor & Destructor Documentation

casacore::ProgressMeter::ProgressMeter ( )

Makes a null progress meter, i.e.

no updates to the screen are generated.

casacore::ProgressMeter::ProgressMeter ( Double  min,
Double  max,
const String title,
const String subtitle,
const String minlabel,
const String maxlabel,
Bool  estimateTime = True,
Int  updateEvery = 1 
)

Create a progress meter with the given min and max values and labels.

if estimateTime is True, an estimate of the time remaining will be made for the user. This estimate assumes that the remaining portion will compute at the same rate as the portion completed so far, so the time should not be estimated for processes which are non-linear.

Any labels which are set to the empty string will have sensible defaults supplied. In particular, minlabel and maxlabel will be set to the display the minimum and maximum values.

Normally the progress bar will be updated with every call to update(). If however you will be sending many events then you might want to update the GUI every updateEvery'th event for efficiency. Generally there's no point updating more than a couple of hundred times since the eye can't distinguish differences in the progress bar position at that level. If updateEvery is <=0, it is set to 1 for you.

casacore::ProgressMeter::ProgressMeter ( Double  min,
Double  max,
const String title 
)
casacore::ProgressMeter::~ProgressMeter ( )

The destruction of the meter will cause an update to be sent with the maximum value.

This will usually cause the GUI window to be removed from the screen. Thus the progress meter should generally live as long as the calculation it is tracking.

casacore::ProgressMeter::ProgressMeter ( const ProgressMeter )
private

Undefined and inaccessible.

Member Function Documentation

void casacore::ProgressMeter::_update ( Double  value,
Bool  force = False 
)
void casacore::ProgressMeter::busy ( )
void casacore::ProgressMeter::done ( )
Double casacore::ProgressMeter::max ( ) const
Double casacore::ProgressMeter::min ( ) const

Display the min and max values of the progress meter.

ProgressMeter& casacore::ProgressMeter::operator= ( const ProgressMeter )
private
void casacore::ProgressMeter::update ( Double  value,
Bool  force = False 
)

Friends And Related Function Documentation

friend class ObjectController
friend

Definition at line 139 of file ProgressMeter.h.

Member Data Documentation

void(* casacore::ProgressMeter::busy_function_p)(Int)
staticprivate

Definition at line 157 of file ProgressMeter.h.

Int(* casacore::ProgressMeter::creation_function_p)(Double, Double, const String &, const String &, const String &, const String &, Bool)
staticprivate

These are set by ObjectController for executables that have the tasking system in them, otherwise they are null and this class just does no-ops.

Definition at line 151 of file ProgressMeter.h.

void(* casacore::ProgressMeter::done_function_p)(Int)
staticprivate

Definition at line 158 of file ProgressMeter.h.

Int casacore::ProgressMeter::id_p
private

Definition at line 142 of file ProgressMeter.h.

Double casacore::ProgressMeter::max_p
private

Definition at line 143 of file ProgressMeter.h.

Double casacore::ProgressMeter::min_p
private

Definition at line 143 of file ProgressMeter.h.

const char* casacore::ProgressMeter::PROGRESSFILE
static

Definition at line 140 of file ProgressMeter.h.

void(* casacore::ProgressMeter::show_function_p)(Int, Double)
staticprivate

Definition at line 156 of file ProgressMeter.h.

Bool casacore::ProgressMeter::showProgress
private

Definition at line 147 of file ProgressMeter.h.

time_t casacore::ProgressMeter::startTime
private

Time the progress meter began.

Definition at line 146 of file ProgressMeter.h.

Int casacore::ProgressMeter::update_count_p
private

Definition at line 144 of file ProgressMeter.h.

Int casacore::ProgressMeter::update_every_p
private

Definition at line 144 of file ProgressMeter.h.

void(* casacore::ProgressMeter::update_function_p)(Int, Double)
staticprivate

Definition at line 155 of file ProgressMeter.h.


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