cepgen is hosted by Hepforge, IPPP Durham
CepGen N/A
Central exclusive processes event generator
ProgressBar Class Reference

A simple progress indicator. More...

#include <include/CepGen/Utils/ProgressBar.h>

Public Member Functions

 ProgressBar (size_t total, size_t period=10)
 Progress bar constructor.
 
 ~ProgressBar ()
 
void reset ()
 Reset the progress bar to its initial state.
 
void setTimer (bool timer_enabled=true)
 Enable the timer? Broadcast the current progress to the bar.
 
void update (size_t iter) const
 

Detailed Description

Definition at line 28 of file ProgressBar.h.

Constructor & Destructor Documentation

◆ ProgressBar()

ProgressBar ( size_t total,
size_t period = 10 )
explicit
Parameters
[in]totalTotal number of steps before completion
[in]periodPeriodicity of ticks refreshing

◆ ~ProgressBar()

Member Function Documentation

◆ reset()

void reset ( )

◆ setTimer()

void setTimer ( bool timer_enabled = true)
Parameters
[in]iterCurrent iteration

Definition at line 37 of file ProgressBar.h.

◆ update()

void update ( size_t iter) const