A progressbar :-)
More...
#include <progressbar.hpp>
Public Member Functions |
| | ProgressBar (long int i=100, const std::string &desc="Working", int cwidth=30) |
| | Constructor.
|
| void | inc (const char *info, int v=1) |
| | increase value of progressbar
|
| void | inc (int v=1) |
| | This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. increase value of progressbar.
|
| void | finish (bool clear=false) |
| | call this when done.
|
| void | finish (char *s) |
| | This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. call this when done.
|
| void | display (const char *info="") |
| | display a string when updating
|
Detailed Description
A progressbar :-)
Definition at line 15 of file progressbar.hpp.
Constructor & Destructor Documentation
| ProgressBar::ProgressBar |
( |
long int |
i = 100, |
|
|
const std::string & |
desc = "Working", |
|
|
int |
cwidth = 30 |
|
) |
| |
Constructor.
- Parameters
-
| i | number of expected steps |
| desc | what to show while working |
| cwidth | of progress bar |
Member Function Documentation
| void ProgressBar::display |
( |
const char * |
info = "" | ) |
|
display a string when updating
- Parameters
-
| info | the string to be shown |
| void ProgressBar::finish |
( |
bool |
clear = false | ) |
|
call this when done.
- Parameters
-
| clear | clears line of progressbar |
| void ProgressBar::finish |
( |
char * |
s | ) |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. call this when done.
- Parameters
-
| s | write this in the line of the progressbar |
| void ProgressBar::inc |
( |
const char * |
info, |
|
|
int |
v = 1 |
|
) |
| |
increase value of progressbar
- Parameters
-
| info | show this text additionally |
| v | increase this much |
| void ProgressBar::inc |
( |
int |
v = 1 | ) |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. increase value of progressbar.
- Parameters
-
The documentation for this class was generated from the following file: