AtomProbe::ProgressBar Class Reference

#include <progress.h>

Public Member Functions
	ProgressBar ()
	~ProgressBar ()
void	setLength (unsigned int l)
	Set the number of markers in the progress bar. More...
void	init ()
	Draw the initial progress bar. More...
void	reset ()
	reset the progress bar internals, in case we want to re-use it More...
void	update (unsigned int newProgress)
	Draw the progress bar as needed, using the given progress value [0,100]. More...
void	finish ()
	Finalise the progress bar. It is not necessary for the progress to be set to 100%, this is done for you. More...
void	abort ()
	Abort drawing the progress. More...

Detailed Description

Definition at line 25 of file progress.h.

Constructor & Destructor Documentation

ProgressBar()

AtomProbe::ProgressBar::ProgressBar ( )

inline

Definition at line 37 of file progress.h.

References reset(), and ~ProgressBar().

Here is the call graph for this function:

~ProgressBar()

AtomProbe::ProgressBar::~ProgressBar

(

)

Definition at line 29 of file progress.cpp.

References finish().

Referenced by ProgressBar().

Here is the call graph for this function:

Member Function Documentation

abort()

void AtomProbe::ProgressBar::abort ( )

inline

Abort drawing the progress.

Definition at line 55 of file progress.h.

finish()

void AtomProbe::ProgressBar::finish

(

)

Finalise the progress bar. It is not necessary for the progress to be set to 100%, this is done for you.

Definition at line 52 of file progress.cpp.

References update().

Referenced by main(), setLength(), update(), and ~ProgressBar().

Here is the call graph for this function:

init()

void AtomProbe::ProgressBar::init

(

)

Draw the initial progress bar.

Definition at line 35 of file progress.cpp.

Referenced by main(), setLength(), and update().

reset()

void AtomProbe::ProgressBar::reset

(

)

reset the progress bar internals, in case we want to re-use it

Definition at line 43 of file progress.cpp.

Referenced by ProgressBar(), and setLength().

setLength()

void AtomProbe::ProgressBar::setLength ( unsigned int  l )

inline

Set the number of markers in the progress bar.

Definition at line 40 of file progress.h.

References finish(), init(), reset(), and update().

Referenced by main(), and update().

Here is the call graph for this function:

update()

void AtomProbe::ProgressBar::update

(

unsigned int

newProgress

)

Draw the progress bar as needed, using the given progress value [0,100].

Definition at line 58 of file progress.cpp.

References finish(), init(), progress, setLength(), and update().

Referenced by callback(), finish(), AtomProbe::generate1DAxialDistHistSweep(), main(), setLength(), and update().

Here is the call graph for this function:

---

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

• include/atomprobe/helper/progress.h
• src/helper/progress.cpp