HLIBpro  2.4
Public Member Functions | List of all members
TProgressBar Class Referenceabstract

base class defining interface

#include <TProgressBar.hh>

Inheritance diagram for TProgressBar:
TCBProgressBar TConsoleProgressBar

Public Member Functions

virtual bool is_initialised () const
 return true if progress meter is initialised
 
virtual void cancel ()
 signal cancelation request
 
virtual bool do_cancel () const
 request cancelation
 
virtual double min () const
 return progress interval (minimum value)
 
virtual double max () const
 return progress interval (maximum value)
 
virtual double val () const
 return current value in progress interval
 
virtual double percentage () const
 return percentage of progress in interval [0,1]
 
virtual void init (const double min, const double max, const double curr)
 
virtual void reset (const double min, const double max, const double curr)
 reset status, e.g. set new values without intialisation
 
virtual void advance (const double f)
 advance progress by f
 
virtual void finish ()
 finish progress bar
 

Member Function Documentation

virtual void init ( const double  min,
const double  max,
const double  curr 
)
virtual

initialise status of progress bar, e.g. [min, max] with current value curr

Reimplemented in TConsoleProgressBar.