trv::sys::ProgressBar Class Reference

Progress bar for tracking tasks. More...

#include <monitor.hpp>

Collaboration diagram for trv::sys::ProgressBar:

Public Member Functions
	ProgressBar (int task_count, std::string name="")
	Construct a progress bar.
void	set_bar_width (int bar_width)
	Set progress bar width.
void	set_nodes (std::vector< float > nodes)
	Set progress bar width.
void	set_task_idx (int task_idx)
	Set current (or initial) task index.
void	set_progress (float progress)
	Set current (or initial) progress value.
void	update (int task_idx_now)
	Update the progress bar.
void	update (float progress_now)
	Update the progress bar.

Public Attributes
std::string	name
	progress bar name
int	task_count = 1
	total task count
int	task_idx = 0
	task index
float	progress = 0.
	progress value in [0, 1] interval

Detailed Description

Progress bar for tracking tasks.

Definition at line 583 of file monitor.hpp.

Constructor & Destructor Documentation

ProgressBar()

trv::sys::ProgressBar::ProgressBar ( int task_count, std::string name = "" )

explicit

Construct a progress bar.

Parameters

task_count	Total task count (at least 1).
name	Progress bar name (default is an empty string).

Definition at line 524 of file monitor.cpp.

Member Function Documentation

set_bar_width()

void trv::sys::ProgressBar::set_bar_width

(

int

bar_width

)

Set progress bar width.

Parameters

bar_width

Progress bar width (at least 1).

Definition at line 537 of file monitor.cpp.

set_nodes()

void trv::sys::ProgressBar::set_nodes

(

std::vector< float >

nodes

)

Set progress bar width.

Parameters

nodes

Progress values (strictly increasing in the interval [0, 1]) at which the bar is updated.

Definition at line 544 of file monitor.cpp.

Here is the caller graph for this function:

set_task_idx()

void trv::sys::ProgressBar::set_task_idx

(

int

task_idx

)

Set current (or initial) task index.

Parameters

task_idx

Current task index within the total task count.

Note

When the tas index is zero, it means no task has completed yet.

Definition at line 553 of file monitor.cpp.

Here is the call graph for this function:

set_progress()

void trv::sys::ProgressBar::set_progress

(

float

progress

)

Set current (or initial) progress value.

Parameters

progress

Current progress value in the interval [0, 1].

Definition at line 566 of file monitor.cpp.

Here is the caller graph for this function:

update() [1/2]

void trv::sys::ProgressBar::update

(

int

task_idx_now

)

Update the progress bar.

Parameters

task_idx_now

Latest completed task index.

Note

When the tas index is zero, it means no task has completed yet.

Definition at line 580 of file monitor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

update() [2/2]

void trv::sys::ProgressBar::update

(

float

progress_now

)

Update the progress bar.

Parameters

progress_now

Latest progress value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 586 of file monitor.cpp.

Here is the call graph for this function:

Member Data Documentation

name

std::string trv::sys::ProgressBar::name

progress bar name

Definition at line 585 of file monitor.hpp.

task_count

int trv::sys::ProgressBar::task_count = 1

total task count

Definition at line 586 of file monitor.hpp.

task_idx

int trv::sys::ProgressBar::task_idx = 0

task index

Definition at line 587 of file monitor.hpp.

progress

float trv::sys::ProgressBar::progress = 0.

progress value in [0, 1] interval

Definition at line 588 of file monitor.hpp.

---

The documentation for this class was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/triumvirate/checkouts/latest/src/triumvirate/include/monitor.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/triumvirate/checkouts/latest/src/triumvirate/src/monitor.cpp