HEJ::ProgressBar< T > Class Template Reference

Class representing (and printing) a progress bar. More...

#include <ProgressBar.hh>

Public Member Functions
	ProgressBar (std::ostream &out, T max)
	Constructor. More...
ProgressBar &	increment (T count)
	Increment progress. More...
ProgressBar &	operator++ ()
	Increase progress by one unit. More...

Detailed Description

template<typename T>
class HEJ::ProgressBar< T >

Class representing (and printing) a progress bar.

Constructor & Destructor Documentation

ProgressBar()

template<typename T >

HEJ::ProgressBar< T >::ProgressBar ( std::ostream &  out, T  max  )

inline

Constructor.

Parameters

out	Output stream
max	Maximum value of the progress parameter

This will print a fixed-width progress bar, which is initially at 0%.

Member Function Documentation

increment()

template<typename T >

ProgressBar & HEJ::ProgressBar< T >::increment ( T  count )

inline

Increment progress.

Parameters

count

Value to add to the current progress parameter

After updating the progess parameter, the progress bar is updated to a percentage that corresponds to the ratio of the current and maximum progress parameters.

operator++()

template<typename T >

ProgressBar & HEJ::ProgressBar< T >::operator++ ( )

inline

Increase progress by one unit.

After updating the progess parameter, the progress bar is updated to a percentage that corresponds to the ratio of the current and maximum progress parameters.

---

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

• /home/andersen/HEJProjects/website/build/hej/include/HEJ/ProgressBar.hh