isis::util::ConsoleFeedback Class Reference

#include <progressfeedback.hpp>

Inheritance diagram for isis::util::ConsoleFeedback:

Public Member Functions
void	close ()
	Close/undisplay a progress display.
size_t	extend (size_t by)
	extend the progress bars maximum by the given value
size_t	getMax ()
size_t	progress (const std::string message="", size_t step=1)
	Set the actual "progress".
void	show (size_t max, std::string header)
	Set the progress display to the given maximum value and "show" it.

---

Detailed Description

Definition at line 63 of file progressfeedback.hpp.

---

Member Function Documentation

void isis::util::ConsoleFeedback::close

(

)

[virtual]

Close/undisplay a progress display.

Implements isis::util::ProgressFeedback.

Definition at line 60 of file progressfeedback.cpp.

size_t isis::util::ConsoleFeedback::extend

(

size_t

by

)

[virtual]

extend the progress bars maximum by the given value

Implements isis::util::ProgressFeedback.

Definition at line 47 of file progressfeedback.cpp.

size_t isis::util::ConsoleFeedback::getMax

(

)

[virtual]

Returns:

the current valued which represents 100%

Implements isis::util::ProgressFeedback.

Definition at line 64 of file progressfeedback.cpp.

size_t isis::util::ConsoleFeedback::progress	(	const std::string	message = "",
		size_t	step = 1
	)		[virtual]

Set the actual "progress".

Behavior is undefined if show was not called before.

Parameters:

message	message to be displayed (default: "")
step	increment of the progress (default: 1)

Returns:

the actual amount of the "progress"

Implements isis::util::ProgressFeedback.

Definition at line 68 of file progressfeedback.cpp.

void isis::util::ConsoleFeedback::show	(	size_t	max,
		std::string	header
	)		[virtual]

Set the progress display to the given maximum value and "show" it.

This will also extend already displayed progress bars.

Implements isis::util::ProgressFeedback.

Definition at line 37 of file progressfeedback.cpp.

---

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

• /scr/tee1/isis/lib/Core/CoreUtils/progressfeedback.hpp
• /scr/tee1/isis/lib/Core/CoreUtils/progressfeedback.cpp