GEDLIB  1.0
Public Member Functions | Related Functions | List of all members
ged::ProgressBar Class Reference

A progress bar class. More...

#include <progress_bar.hpp>

Public Member Functions

 ProgressBar (std::size_t num_tasks)
 Constructs a progress bar for given number of tasks. More...
 
void increment ()
 Increments the number of solved tasks.
 
void reset ()
 Sets the number of solved tasks to 0.
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const ProgressBar &progress_bar)
 Streams the current progress in percent and the estimated remaining runtime. More...
 

Detailed Description

A progress bar class.

Definition at line 39 of file progress_bar.hpp.

Constructor & Destructor Documentation

◆ ProgressBar()

ged::ProgressBar::ProgressBar ( std::size_t  num_tasks)

Constructs a progress bar for given number of tasks.

Parameters
[in]num_tasksThe number of tasks.

Definition at line 33 of file progress_bar.ipp.

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  os,
const ProgressBar progress_bar 
)
related

Streams the current progress in percent and the estimated remaining runtime.

Parameters
[in,out]osOutput stream.
[in]progress_barThe progress bar whose current progress should be streamed.
Returns
The output stream os.

Definition at line 51 of file progress_bar.ipp.


The documentation for this class was generated from the following files: