tpie::progress_indicator_subindicator Class Reference

Inherits tpie::progress_indicator_base.

Inherited by tpie::fractional_subindicator.

Public Member Functions
void	refresh ()
	Display the indicator. More...
virtual void	push_breadcrumb (const char *crumb, description_importance importance)
virtual void	pop_breadcrumb ()
virtual void	init (stream_size_type range)
	Initialize progress indicator. More...
virtual void	done ()
	Advance the indicator to the end. More...
void	set_crumb (const std::string &c)
void	setup (progress_indicator_base *parent, stream_size_type outerRange, const char *crumb=0, description_importance importance=IMPORTANCE_MAJOR, log_group_mode::type logGroupMode=log_group_mode::enabled)
	progress_indicator_subindicator (progress_indicator_subindicator &&o)
progress_indicator_subindicator &	operator= (progress_indicator_subindicator &&o)
	progress_indicator_subindicator (progress_indicator_base *parent, stream_size_type outerRange, const char *crumb=0, description_importance importance=IMPORTANCE_MAJOR, log_group_mode::type logGroupMode=log_group_mode::enabled)
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	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 ()

Protected Attributes
progress_indicator_base *	m_parent
stream_size_type	m_outerRange
stream_size_type	m_oldValue
std::string	m_crumb
description_importance	m_importance
log_group_mode::type	m_logGroupMode
bool	m_init_called
bool	m_done_called
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...

Detailed Description

Definition at line 40 of file progress_indicator_subindicator.h.

Member Function Documentation

virtual void tpie::progress_indicator_subindicator::done ( )

virtual

Advance the indicator to the end.

Reimplemented from tpie::progress_indicator_base.

Reimplemented in tpie::fractional_subindicator.

stream_size_type tpie::progress_indicator_base::get_current ( )

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.

{ return m_current; }

stream_size_type tpie::progress_indicator_base::get_range ( )

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.

{ return m_range; }

virtual void tpie::progress_indicator_subindicator::init ( stream_size_type  range )

virtual

Initialize progress indicator.

Parameters

range

The number of times step() is going to be called.

Reimplemented from tpie::progress_indicator_base.

Reimplemented in tpie::fractional_subindicator.

void tpie::progress_indicator_base::raw_step ( stream_size_type  step )

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().

                                         {
        m_current += step;
        // Don't call call_refresh(); call refresh() directly instead.
        refresh();
    }

void tpie::progress_indicator_subindicator::refresh ( )

virtual

Display the indicator.

Implements tpie::progress_indicator_base.

virtual void tpie::progress_indicator_base::set_range ( stream_size_type  range )

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.

Parameters

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().

                                                   {
        m_range = range;
    }

void tpie::progress_indicator_base::step ( stream_size_type  step = 1 )

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().

                                       {
        m_current += step;

        if (step >= m_remainingSteps) {
            call_refresh();
        } else {
            m_remainingSteps -= step;
        }
    }

Member Data Documentation

stream_size_type tpie::progress_indicator_base::m_current

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().

stream_size_type tpie::progress_indicator_base::m_range

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().

---

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

• progress_indicator_subindicator.h