Class ProgressBar¶
Defined in File progress_bar.h
Class Documentation¶
-
class ProgressBar¶
Defining the global
NOPROGRESSwill disable all progress operations, potentially speeding up a program. The look of the progress bar is shown in ProgressBar.hpp.Public Functions
-
void start(uint32_t total_work)¶
Start/reset the progress bar.
- Parameters:
total_work – The amount of work to be completed, usually specified in cells.
-
void update(uint32_t work_done0)¶
Update the visible progress bar, but only if enough work has been done.
Define the global
NOPROGRESSflag to prevent this from having an effect. Doing so may speed up the program’s execution.
-
inline ProgressBar &operator++()¶
Increment by one the work done and update the progress bar.
-
inline double stop()¶
Stop the progress bar. Throws an exception if it wasn’t started.
- Returns:
The number of seconds the progress bar was running.
-
inline double time_it_took()¶
- Returns:
Return the time the progress bar ran for.
-
inline uint32_t cellsProcessed() const¶
-
void start(uint32_t total_work)¶