The base class for indicating the progress of some task. More...

#include <tpie/progress_indicator_base.h>

Inherited by tpie::pipelining::bits::proxy_progress_indicator, tpie::progress_indicator_null, tpie::progress_indicator_subindicator, and tpie::progress_indicator_terminal.

Public Member Functions
	progress_indicator_base (stream_size_type range)
	Initializes the indicator. More...

virtual	~progress_indicator_base ()
	The destructor. Nothing is done. 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)

virtual void	init (stream_size_type range=0)
	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 ()=0
	Display the indicator. 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...

Detailed Description

The base class for indicating the progress of some task.

At times, especially when processing large data sets, the user might want the program to provide information about how much progress has been made. TPIE provides a class hierarchy with an abstract base class progress_indicator_base for realizing such indicators. TPIE offers terminal-based indicators, such as progress_indicator_arrow that shows an extending arrow or progress_indicator_spin that shows a spinning "wheel". To allow for other types of indicators such as graphics-based indicators for (interfaces to) indicators provided by other APIs, the terminal-based indicators inherit from progress_indicator_terminal which in turn inherits from progress_indicator_base. To include other types of non-terminal-based indicators, the user thus should subclass progress_indicator_base. All indicators are based upon the following concept: The indicator is given a range [minRange , maxRange ] and a parameter stepValue/ For each update to the indicator and starting at minRange , the progress status will be advanced by stepValue units.

Definition at line 63 of file progress_indicator_base.h.

Constructor & Destructor Documentation

tpie::progress_indicator_base::progress_indicator_base ( stream_size_type range )

inline

Initializes the indicator.

Parameters

range The upper bound of the counting range.

Definition at line 70 of file progress_indicator_base.h.

                                                     : 
         m_range(range),
         m_current(0),
         //m_lastUpdate(getticks()),
         m_next(0),
         m_predictor(0) {
         compute_threshold();
     }

virtual tpie::progress_indicator_base::~progress_indicator_base ( )

inlinevirtual

The destructor. Nothing is done.

Definition at line 82 of file progress_indicator_base.h.

                                        {
         // Do nothing.
     };

Member Function Documentation

virtual void tpie::progress_indicator_base::done ( )

inlinevirtual

Advance the indicator to the end.

Reimplemented in tpie::progress_indicator_terminal, tpie::fractional_subindicator, tpie::progress_indicator_null, and tpie::progress_indicator_subindicator.

Definition at line 140 of file progress_indicator_base.h.

Referenced by tpie::merge_sorter< T, UseProgress, pred_t >::calc(), tpie::pipelining::passive_reverser< T >::source_t< dest_t >::go(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), and tpie::parallel_sort().

140 {}

stream_size_type tpie::progress_indicator_base::get_current ( )

inline

Get the current value of the step counter.

Definition at line 162 of file progress_indicator_base.h.

References m_current.

Referenced by tpie::pipelining::bits::proxy_progress_indicator::refresh().

162 { return m_current; }

tpie::progress_indicator_base::m_current

stream_size_type m_current

The current progress count [m_minRange...m_maxRange].

Definition: progress_indicator_base.h:184

stream_size_type tpie::progress_indicator_base::get_range ( )

inline

Get the maximum value of the current range.

Definition at line 167 of file progress_indicator_base.h.

References m_range.

Referenced by tpie::pipelining::bits::proxy_progress_indicator::refresh().

167 { return m_range; }

tpie::progress_indicator_base::m_range

stream_size_type m_range

The upper bound of the counting range.

Definition: progress_indicator_base.h:181

virtual void tpie::progress_indicator_base::init ( stream_size_type range = 0 )

inlinevirtual

Initialize progress indicator.

Parameters

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 124 of file progress_indicator_base.h.

References m_current, refresh(), and set_range().

Referenced by tpie::merge_sorter< T, UseProgress, pred_t >::calc(), tpie::pipelining::passive_reverser< T >::source_t< dest_t >::go(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), and tpie::parallel_sort().

                                                 {
         if (range != 0) set_range(range);
         m_current = 0;
         refresh();
         
         m_start = getticks();
         m_next = 1;
 
 #ifndef TPIE_NDEBUG
         m_lastCalled = getticks();
 #endif
     }

virtual void tpie::progress_indicator_base::refresh ( )

pure virtual

Display the indicator.

Implemented in tpie::progress_indicator_terminal, tpie::progress_indicator_spin, tpie::progress_indicator_arrow, tpie::progress_indicator_null, tpie::pipelining::bits::proxy_progress_indicator, and tpie::progress_indicator_subindicator.

Referenced by init(), and step().

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

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.

Parameters

range The new upper bound.

Reimplemented in tpie::progress_indicator_null.

Definition at line 150 of file progress_indicator_base.h.

References m_range.

Referenced by init().

                                                    {
         m_range = range;
     }

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

inline

Record an increment to the indicator and advance the indicator.

Definition at line 89 of file progress_indicator_base.h.

References tpie::log_debug(), m_current, and refresh().

Referenced by tpie::merge_sorter< T, UseProgress, pred_t >::calc(), tpie::pipelining::passive_reverser< T >::source_t< dest_t >::go(), tpie::pipelining::serialization_bits::sort_calc_t< Traits >::go(), tpie::ami::Internal_Sorter_Obj< T, Compare >::sort(), and tpie::pipelining::node::step().

                                        {
         m_current += step;
         
 #ifndef TPIE_NDEBUG
         {
             ticks currentTicks = getticks();
             if (elapsed(currentTicks,m_lastCalled) > m_frequency * m_threshold * 5)
                 tpie::log_debug() << "Step was not called for an estimated " 
                                   << (elapsed(currentTicks,m_lastCalled) / (m_frequency * m_threshold))
                                   << " seconds" << std::endl;;
             m_lastCalled = currentTicks;
         }
 #endif  
         if (m_current > m_next) {
             ticks currentTicks = getticks();
             m_next = static_cast<stream_size_type>(
                 static_cast<double>(m_current) * (elapsed(currentTicks, m_start) + m_threshold)/
                 elapsed(currentTicks, m_start));
             if (m_next > m_current *2) m_next=m_current*2; //For bad guestimation in the beginning
             refresh();
         }
     }