OEConsoleProgressTracer

class OEConsoleProgressTracer : public OETracerBase

The following methods are publicly inherited from OETracerBase:

Aborted Push SetProgress
Pop Refresh SetTask

Constructors

OEConsoleProgressTracer()

Default constructor.

Aborted

bool Aborted()

This is a no-op method for this class.

Pop

void Pop()

Prints out the task name and the progress bar along with the elapsed time. An example output is shown below.

Screen generation        [========----------------------------------------------------]  13.53%  00:00:53

Push

void Push(std::string task)

This is equivalent to calling OEConsoleProgressTracer.SetTask.

Refresh

void Refresh()

This is a no-op method for this class.

SetProgress

void SetProgress(double percent)
void SetProgress(unsigned int current, unsigned int total)

Prints out the task name and its progress bar when the current progress of the task has reached the percentage of completion specified by percent or by current / total.

SetTask

void SetTask(std::string task)

Registers the tracer with a task name specified by, task. It also starts the timer to trace the progress of the task and prints out the initial progress bar, i.e. 0.0.