ImFusion SDK 4.3
AsciiProgress Class Reference

#include <ImFusion/Base/AsciiProgress.h>

Displays a basic progress bar with ASCII characters on the console window. More...

+ Inheritance diagram for AsciiProgress:

Detailed Description

Displays a basic progress bar with ASCII characters on the console window.

The progress will be displayed in the following format:

[==== ] 42% Computing...

The text (in this case "Computing...") is always displayed on the right. Busy indicators will displayed as such

[ = ] Computing...

where each update (independent of the value) wanders the indicator from left to right and back.

AsciiProgress will always display a maximum of one progress bar even if multiple tasks were added. In this case the indicator will be the one of the first added task, however the text on the right will show an additional "(N tasks total)" to make this limitation clearer.

Instead of a new line, the updateProgress always ends with a \r so that the next progress update overwrites the previous one. If the application prints other text it also overwrites the last progress.

Public Member Functions

void cancelAllTasks ()
 
- Public Member Functions inherited from Progress
Task addTask (int numSteps, const std::string &description)
 Create a new progress report for an operation with the given number of steps.
 
Task addBusyIndicator (const std::string &description)
 Create a busy indicator for an operation but does not have a predefined number of steps.
 

The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close