Skip to main content

ClikaRT::progress::ProgressGroup

class

Header: ClikaRT/progress/progress.h

Owns and renders several bars as one block: it controls the whole region and its cursor, so parallel bars never interleave or jump. print_above emits a line above the live bars without corrupting them (raw on a terminal; routed through the default logging channel (logging::logger()) when output isn't a terminal, so a handler installed there receives it). Writes to stdout.

Member functions​

ProgressGroup()​

ProgressGroup()

an empty group; add bars with add_bar()

Declared in ClikaRT/progress/progress.h, line 190

~ProgressGroup()​

~ProgressGroup()

destructor

Declared in ClikaRT/progress/progress.h, line 191

ProgressGroup(ProgressGroup)​

ProgressGroup(ProgressGroup&& other) noexcept

move-construct

Declared in ClikaRT/progress/progress.h, line 192

operator=(ProgressGroup)​

ProgressGroup& operator=(ProgressGroup&& other) noexcept

move-assign

Declared in ClikaRT/progress/progress.h, line 193

ProgressGroup(ProgressGroup)​

ProgressGroup(const ProgressGroup&) =delete

Declared in ClikaRT/progress/progress.h, line 194

operator=(ProgressGroup)​

ProgressGroup& operator=(const ProgressGroup&) =delete

Declared in ClikaRT/progress/progress.h, line 195

add_bar()​

Bar add_bar()

Add a managed bar; configure the returned handle, then drive it. May be called at any time, before the first refresh or while earlier bars are already rendering (a bar-per-work-item loop adds each bar as its item starts).

Declared in ClikaRT/progress/progress.h, line 201

void print_above(std::string_view text)

Emit text above the live bars (clean; it never corrupts them).

Declared in ClikaRT/progress/progress.h, line 204

refresh()​

void refresh()

Repaint all bars now.

Declared in ClikaRT/progress/progress.h, line 207

start_auto_refresh()​

void start_auto_refresh()

Repaint on a background thread until stop_auto_refresh()/done().

Declared in ClikaRT/progress/progress.h, line 209

stop_auto_refresh()​

void stop_auto_refresh()

stop the background repaint thread

Declared in ClikaRT/progress/progress.h, line 210

done()​

void done()

Finalize: stop the driver and leave the final bars (or erase if transient).

Declared in ClikaRT/progress/progress.h, line 212

all_completed()​

bool all_completed() const

whether every added bar completed

Declared in ClikaRT/progress/progress.h, line 214