A class that indicates the progress by expanding an arrow. More...

#include <tpie/progress_indicator_arrow.h>

Inherits tpie::progress_indicator_terminal.

Public Member Functions
	progress_indicator_arrow (const char *title, stream_size_type range, std::ostream &os=std::cout)
	Initializes the indicator. More...

void	set_indicator_length (int indicatorLength)
	Set the maximum length of the indicator. More...

virtual void	reset ()
	Reset the current state of the indicator and its current length. More...

void	push_breadcrumb (const char *crumb, description_importance)

void	pop_breadcrumb ()

virtual void	refresh ()
	Display the indicator. 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...

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

Protected Member Functions
void	display_percentage ()
	Compute and print the percentage or step count. More...

Protected Attributes
memory_size_type	m_indicatorLength
	The maximal length of the indicator. More...

std::string	m_status
	The previously displayed status line. More...

std::ostream &	m_os
	ostream on which to display the progress indicator More...

std::deque< std::string >	m_crumbs

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

Detailed Description

A class that indicates the progress by expanding an arrow.

Definition at line 37 of file progress_indicator_arrow.h.

Constructor & Destructor Documentation

tpie::progress_indicator_arrow::progress_indicator_arrow	(	const char *	title,
		stream_size_type	range,
		std::ostream &	os = `std::cout`
	)

inline

Initializes the indicator.

Parameters

title	The title of the progress indicator.
range	The number of times we call step

Definition at line 48 of file progress_indicator_arrow.h.

References m_indicatorLength.

                                                                                                     :
         progress_indicator_terminal(title, range, os) , m_indicatorLength(0), m_os(os) {
         m_indicatorLength = 110;
     }

Member Function Documentation

void tpie::progress_indicator_terminal::display_percentage ( )

inlineprotectedinherited

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 tpie::progress_indicator_terminal::refresh().

     {
         //if (m_percentageUnit) {
         //  std::cout << std::setw(6) << std::setiosflags(std::ios::fixed) << std::setprecision(2) 
         //           << ((static_cast<double>(m_current) * 100.0) / 
         //               static_cast<double>(m_percentageUnit))
         //           << "%";
         //}
         //else {
         //      std::cout << 
         //}
         stream_size_type r = (m_current) * 100 / (m_range);
         m_os << r << '%';
     }

void tpie::progress_indicator_terminal::done ( )

inlinevirtualinherited

Advance the indicator to the end and print an (optional) message that is followed by a newline.

Parameters

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 tpie::progress_indicator_terminal::refresh().

                 {
         m_current = m_range;
         refresh();
         m_os << std::endl;
     }

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.

151 { 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:173

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.

156 { 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:170

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

inlinevirtualinherited

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

                                                 {
         if (range != 0) set_range(range);
         m_current = 0;
         call_refresh();
     }

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();
     }

virtual void tpie::progress_indicator_arrow::refresh ( )

inlinevirtual

Display the indicator.

Reimplemented from tpie::progress_indicator_terminal.

Definition at line 81 of file progress_indicator_arrow.h.

References tpie::progress_indicator_base::m_current, m_indicatorLength, tpie::progress_indicator_base::m_range, and tpie::progress_indicator_terminal::m_title.

                            {
         //  Compute the relative length of the arrow.
         //std::cout << "refresh " << m_description << std::endl;
 
         memory_size_type l = m_indicatorLength - 12  - m_title.size();
         memory_size_type progress = (m_range != 0) ?
             static_cast<memory_size_type>(l * m_current / m_range) : 0;
 
         std::string newStatus;
         {
             std::stringstream status;
 
             //  Don't print the last item.
             if (progress >= l) progress = l -1;
 
             //  Go to the beginning of the line and print the description.
             status << m_title << " [";
 
             //  Extend the arrow.
 
             status << std::string(progress, '=');
             status << '>';
 
             //  Print blank space.
             status << std::string(l-progress-1, ' ');
             status << "] ";
 
             status << m_current * 100 / m_range << '%';
 
             for (std::deque<std::string>::iterator i = m_crumbs.begin(); i != m_crumbs.end(); ++i) {
                 if (i == m_crumbs.begin()) status << ' ';
                 else status << " > ";
                 status << *i;
             }
 
             status << ' ' << estimated_remaining_time();
 
             newStatus = status.str();
         }
 
         if (newStatus != m_status) {
 #ifdef WIN32
             m_os << '\r' << std::string(m_status.size(), ' ') << '\r'
                 << newStatus << std::flush;
 #else
             m_os << "\r\x1B[K" << newStatus << std::flush;
 #endif
             std::swap(newStatus, m_status);
         }
     }

virtual void tpie::progress_indicator_arrow::reset ( )

inlinevirtual

Reset the current state of the indicator and its current length.

Definition at line 66 of file progress_indicator_arrow.h.

References tpie::progress_indicator_base::m_current.

                          {
         m_current  = 0;
     }

void tpie::progress_indicator_arrow::set_indicator_length ( int indicatorLength )

inline

Set the maximum length of the indicator.

The length is enforced to be an integer in [2,60].

Parameters

indicatorLength The maximum length of the indicator.

Definition at line 59 of file progress_indicator_arrow.h.

References m_indicatorLength.

                                                    {
         m_indicatorLength = std::max(2, std::min(60, indicatorLength));
     }

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_terminal::set_title ( const std::string & title )

inlineinherited

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.

Parameters

title The title of the new task to be monitored.

Definition at line 116 of file progress_indicator_terminal.h.

References tpie::progress_indicator_terminal::m_title.

     {
         m_title = title;
         m_os << title << std::endl;
     }

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;
         }
     }