OEConsoleProgressTracer

class OEConsoleProgressTracer : public OETracerBase

The following methods are publicly inherited from OETracerBase:

`Aborted`	`Push`	`SetProgress`
`Pop`	`Refresh`	`SetTask`

Constructors

OEConsoleProgressTracer() -> OEConsoleProgressTracer

Default constructor.

Aborted

Aborted() -> bool

This is a no-op method for this class.

Pop

Pop() -> None

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

Push(task: str) -> None

This is equivalent to calling OEConsoleProgressTracer.SetTask.

Refresh

Refresh() -> None

This is a no-op method for this class.

SetProgress

SetProgress(percent: float) -> None
SetProgress(current: int, total: int) -> None

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

SetTask(task: str) -> None

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.