a dummy progress indicator that produces no output More...
#include <tpie/progress_indicator_null.h>
Inherits tpie::progress_indicator_base.
Public Member Functions | |
progress_indicator_null (stream_size_type range=0) | |
virtual void | init (stream_size_type range) |
Initialize progress indicator. More... | |
virtual void | done () |
Advance the indicator to the end. More... | |
virtual void | set_range (stream_size_type range) |
Set the upper bound of the counting range. 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... | |
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 Attributes | |
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 dummy progress indicator that produces no output
Definition at line 39 of file progress_indicator_null.h.
|
inlinevirtual |
Advance the indicator to the end.
Reimplemented from tpie::progress_indicator_base.
Definition at line 47 of file progress_indicator_null.h.
|
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.
|
inlinevirtual |
Initialize progress indicator.
range | The number of times step() is going to be called. |
Reimplemented from tpie::progress_indicator_base.
Definition at line 46 of file progress_indicator_null.h.
References tpie::unused().
|
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.
Definition at line 49 of file progress_indicator_null.h.
|
inlinevirtual |
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 from tpie::progress_indicator_base.
Definition at line 48 of file progress_indicator_null.h.
References tpie::unused().
|
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 tpie::progress_indicator_terminal::display_percentage(), tpie::progress_indicator_terminal::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 tpie::progress_indicator_terminal::display_percentage(), tpie::progress_indicator_terminal::done(), tpie::progress_indicator_base::get_range(), tpie::progress_indicator_arrow::refresh(), and tpie::progress_indicator_base::set_range().