class for progress bar calling user defined call back function upon change in status
#include <TProgressBar.hh>
Public Types |
enum | |
typedef void(* | func_t )(const double *values, int *cancel, void *arg) |
Public Member Functions |
| TCBProgressBar (const func_t cb, void *cb_arg=NULL) |
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 Typedef Documentation
typedef void(* func_t)(const double *values, int *cancel, void *arg) |
callback function type values is an array with values as defined by enum below cancel indicates cancelation request by user arg user arguments to call back function
Member Enumeration Documentation
fields in value array progress bar callback function
Constructor & Destructor Documentation
construct progress bar with cb as call back function and cb_arg as optional arguments provided by each call to cb