C++ class Util::Helper::ProgressIndicator
ProgressIndicator

public

Inheritance Graph

graph BT
	ProgressIndicator
	click ProgressIndicator "classUtil_1_1ProgressIndicator"

Description

Class for printing progress state to console

Author: Paul Justus, Benjamin Eikel

Date: 2010-06-08

Public Functions

	ProgressIndicator(std::string description, uint32_t totalSteps, double updateInterval)
void	increment()
bool	operator==(const ProgressIndicator & other) const

---

Documentation

function
Util::ProgressIndicator::ProgressIndicator

public

ProgressIndicator(	std::string	description,
	uint32_t	totalSteps,
	double	updateInterval
)

Create a ProgressIndicator .

Parameters

description

Description of the progress that is output together with the progress state

totalSteps

Total number of steps during the progress

updateInterval

Duration in seconds indicates between output of progress state

_{Defined in Util/ProgressIndicator.h:40}

---

function
Util::ProgressIndicator::increment

public

void increment(	)

Increment the number of finished steps by one. Print the progress state if the elapsed time since the last update is larger than the defined interval.

_{Defined in Util/ProgressIndicator.h:46}

---

function
Util::ProgressIndicator::operator==

public

const

inline

bool operator==(	const ProgressIndicator &	other ) const

_{Defined in Util/ProgressIndicator.h:48}

---