#include <progressfeedback.hpp>
Inheritance diagram for isis::util::ProgressFeedback:
Public Member Functions | |
| virtual void | close ()=0 |
| Close/undisplay a progress display. | |
| virtual size_t | extend (size_t by)=0 |
| extend the progress bars maximum by the given value | |
| virtual size_t | getMax ()=0 |
| ProgressFeedback & | operator++ () |
| Increment the "progress" by one. | |
| virtual size_t | progress (const std::string message="", size_t step=1)=0 |
| Set the actual "progress". | |
| virtual void | show (size_t max, std::string header="")=0 |
| Set the progress display to the given maximum value and "show" it. | |
| virtual | ~ProgressFeedback () |
Detailed Description
Definition at line 33 of file progressfeedback.hpp.
Constructor & Destructor Documentation
| isis::util::ProgressFeedback::~ProgressFeedback | ( | ) | [virtual] |
Definition at line 35 of file progressfeedback.cpp.
Member Function Documentation
| virtual void isis::util::ProgressFeedback::close | ( | ) | [pure virtual] |
Close/undisplay a progress display.
Implemented in isis::util::ConsoleFeedback.
| virtual size_t isis::util::ProgressFeedback::extend | ( | size_t | by | ) | [pure virtual] |
extend the progress bars maximum by the given value
Implemented in isis::util::ConsoleFeedback.
| virtual size_t isis::util::ProgressFeedback::getMax | ( | ) | [pure virtual] |
- Returns:
- the current valued which represents 100%
Implemented in isis::util::ConsoleFeedback.
| ProgressFeedback & isis::util::ProgressFeedback::operator++ | ( | ) |
Increment the "progress" by one.
Definition at line 29 of file progressfeedback.cpp.
| virtual size_t isis::util::ProgressFeedback::progress | ( | const std::string | message = "", |
| size_t | step = 1 |
||
| ) | [pure 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"
Implemented in isis::util::ConsoleFeedback.
| virtual void isis::util::ProgressFeedback::show | ( | size_t | max, |
| std::string | header = "" |
||
| ) | [pure virtual] |
Set the progress display to the given maximum value and "show" it.
This will also extend already displayed progress bars.
Implemented in isis::util::ConsoleFeedback.
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
