class for a progress bar using IO stream to print the progress More...
#include <TProgressBar.hh>
Inheritance diagram for TStreamProgressBar:
Public Member Functions | |
| TStreamProgressBar (std::ostream &out_stream, const bool use_unicode=false) | |
| TStreamProgressBar (std::ostream &out_stream, const String &format, const bool use_unicode=false) | |
| virtual | ~TStreamProgressBar () |
| dtor | |
| virtual void | init (const double min, const double max, const double curr) |
| virtual void | finish () |
| finish progress bar | |
 Public Member Functions inherited from TProgressBar | |
| 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 | 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 | |
Detailed Description
- the format string follows printf style with
- b : print bar with optional length, e.g. %30b for 30 characters
- i : print progress indicator
- p : print progress percentage
- e : print time to finish (ETA)
- t : print elapsed time
- m : print current memory usage (if supported)
- if format == "", a default definition is used
Constructor & Destructor Documentation
| TStreamProgressBar | ( | std::ostream & | out_stream, |
| const bool | use_unicode = false |
||
| ) |
construct progress bar with output stream out_stream and standard output format; if use_unicode is true, unicode is used for special characters
| TStreamProgressBar | ( | std::ostream & | out_stream, |
| const String & | format, | ||
| const bool | use_unicode = false |
||
| ) |
construct progress bar with output stream out_stream and output format defined by format; if use_unicode is true, unicode is used for special characters
Member Function Documentation
|
virtual |
initialise status of progress bar, e.g. [min, max] with current value curr
Reimplemented from TProgressBar.
