A class that indicates the progress by a simple counter that is printed to the terminal. More...
#include <tpie/progress_indicator_terminal.h>
Inherits tpie::progress_indicator_base.
Inherited by tpie::progress_indicator_arrow, and tpie::progress_indicator_spin.
Public Member Functions | |
progress_indicator_terminal (const char *title, stream_size_type range, std::ostream &os=std::cout) | |
Initializes the indicator. More... | |
virtual | ~progress_indicator_terminal () |
The destructor. More... | |
void | done () |
Advance the indicator to the end and print an (optional) message that is followed by a newline. More... | |
void | set_title (const std::string &title) |
Set the title of a new task to be monitored. More... | |
virtual void | refresh () |
Display the indicator. More... | |
void | step (stream_size_type step=1) |
Record an increment to the indicator and advance the indicator. More... | |
void | raw_step (stream_size_type step) |
Internal method used in fractional progress. More... | |
virtual void | init (stream_size_type range=0) |
Initialize progress indicator. More... | |
virtual void | set_range (stream_size_type range) |
Set the upper bound of the counting range. More... | |
stream_size_type | get_current () |
Get the current value of the step counter. More... | |
stream_size_type | get_range () |
Get the maximum value of the current range. More... | |
execution_time_predictor * | get_time_predictor () |
void | set_time_predictor (execution_time_predictor *p) |
std::string | estimated_remaining_time () |
virtual void | push_breadcrumb (const char *, description_importance) |
virtual void | pop_breadcrumb () |
Protected Member Functions | |
void | display_percentage () |
Compute and print the percentage or step count. More... | |
Protected Attributes | |
std::string | m_title |
A string holding the description of the title. More... | |
stream_size_type | m_range |
The upper bound of the counting range. More... | |
stream_size_type | m_current |
The current progress count [m_minRange...m_maxRange]. More... | |
A class that indicates the progress by a simple counter that is printed to the terminal.
Definition at line 40 of file progress_indicator_terminal.h.
|
inline |
Initializes the indicator.
title | The title of the progress indicator. indicator. |
minRange | The lower bound of the range. |
Definition at line 54 of file progress_indicator_terminal.h.
|
inlinevirtual |
The destructor.
Free the space allocated for title/description.
Definition at line 86 of file progress_indicator_terminal.h.
|
inlineprotected |
Compute and print the percentage or step count.
Definition at line 143 of file progress_indicator_terminal.h.
References tpie::progress_indicator_base::m_current, and tpie::progress_indicator_base::m_range.
Referenced by refresh().
|
inlinevirtual |
Advance the indicator to the end and print an (optional) message that is followed by a newline.
text | The message to be printed at the end of the indicator. |
Reimplemented from tpie::progress_indicator_base.
Definition at line 99 of file progress_indicator_terminal.h.
References tpie::progress_indicator_base::m_current, tpie::progress_indicator_base::m_range, and refresh().
|
inlineinherited |
Get the current value of the step counter.
Definition at line 151 of file progress_indicator_base.h.
References tpie::progress_indicator_base::m_current.
|
inlineinherited |
Get the maximum value of the current range.
Definition at line 156 of file progress_indicator_base.h.
References tpie::progress_indicator_base::m_range.
|
inlinevirtualinherited |
Initialize progress indicator.
range | The number of times step() is going to be called. |
Reimplemented in tpie::fractional_subindicator, tpie::progress_indicator_null, and tpie::progress_indicator_subindicator.
Definition at line 120 of file progress_indicator_base.h.
References tpie::progress_indicator_base::m_current, and tpie::progress_indicator_base::set_range().
Referenced by tpie::merge_sorter< T, UseProgress, pred_t, store_t >::calc(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), and tpie::parallel_sort().
|
inlineinherited |
Internal method used in fractional progress.
In a hierarchy of fractional progress subindicators, only the lowest level of indicators should determine how many steps should pass until the next call to refresh(). When this happens, the subindicator calls raw_step() on its parent indicator rather than step(), which will short-circuit the logic and call the virtual method refresh() directly. You should probably not use this method; use step() instead.
Definition at line 110 of file progress_indicator_base.h.
References tpie::progress_indicator_base::m_current, tpie::progress_indicator_base::refresh(), and tpie::progress_indicator_base::step().
|
inlinevirtual |
Display the indicator.
Implements tpie::progress_indicator_base.
Reimplemented in tpie::progress_indicator_spin, and tpie::progress_indicator_arrow.
Definition at line 128 of file progress_indicator_terminal.h.
References display_percentage(), and m_title.
Referenced by done().
|
inlinevirtualinherited |
Set the upper bound of the counting range.
This method also implies a reset of the counter. In order to be able to set the uper bound independent of setting the lower bound, no range checking is done.
range | The new upper bound. |
Reimplemented in tpie::progress_indicator_null.
Definition at line 139 of file progress_indicator_base.h.
References tpie::progress_indicator_base::m_range.
Referenced by tpie::progress_indicator_base::init().
|
inline |
Set the title of a new task to be monitored.
The terminal line will be newline'd, and the title will be followed by a newline as well.
title | The title of the new task to be monitored. |
Definition at line 116 of file progress_indicator_terminal.h.
References m_title.
|
inlineinherited |
Record an increment to the indicator and advance the indicator.
Definition at line 90 of file progress_indicator_base.h.
References tpie::progress_indicator_base::m_current.
Referenced by tpie::merge_sorter< T, UseProgress, pred_t, store_t >::calc(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), tpie::progress_indicator_base::raw_step(), tpie::ami::Internal_Sorter_Obj< T, Compare >::sort(), and tpie::pipelining::node::step().
|
protectedinherited |
The current progress count [m_minRange...m_maxRange].
Definition at line 173 of file progress_indicator_base.h.
Referenced by display_percentage(), done(), tpie::progress_indicator_base::get_current(), tpie::progress_indicator_base::init(), tpie::progress_indicator_base::raw_step(), tpie::progress_indicator_arrow::refresh(), tpie::progress_indicator_spin::refresh(), tpie::progress_indicator_arrow::reset(), and tpie::progress_indicator_base::step().
|
protectedinherited |
The upper bound of the counting range.
Definition at line 170 of file progress_indicator_base.h.
Referenced by display_percentage(), done(), tpie::progress_indicator_base::get_range(), tpie::progress_indicator_arrow::refresh(), and tpie::progress_indicator_base::set_range().
|
protected |
A string holding the description of the title.
Definition at line 159 of file progress_indicator_terminal.h.
Referenced by tpie::progress_indicator_arrow::refresh(), refresh(), and set_title().