A class that indicates the progress by a spinning cross. More...

#include <tpie/progress_indicator_spin.h>

Inherits tpie::progress_indicator_terminal.

Public Member Functions
	progress_indicator_spin (const std::string &title, const std::string &description, stream_size_type minRange, stream_size_type maxRange, stream_size_type stepValue)
	Initializes the indicator. More...

	progress_indicator_spin (const progress_indicator_spin &other)
	Copy-constructor. More...

progress_indicator_spin &	operator= (const progress_indicator_spin &other)
	Assignment operator. More...

virtual	~progress_indicator_spin ()
	The destructor. More...

virtual void	refresh ()
	Display the indicator. More...

void	done ()
	Advance the indicator to the end. 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 ()

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
char *	m_symbols
	The characters used for the spinning indicator. More...

unsigned short	m_numberOfStates
	The number of characters used for the spinning indicator. More...

unsigned short	m_state
	The current character used for the spinning indicator. More...

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 a spinning cross.

Definition at line 41 of file progress_indicator_spin.h.

Constructor & Destructor Documentation

◆ progress_indicator_spin() [1/2]

tpie::progress_indicator_spin::progress_indicator_spin	(	const std::string &	title,
		const std::string &	description,
		stream_size_type	minRange,
		stream_size_type	maxRange,
		stream_size_type	stepValue
	)

inline

Initializes the indicator.

Parameters

title	The title of the progress indicator.
description	A text to be printed in front of the indicator.
minRange	The lower bound of the range.
maxRange	The upper bound of the range.
stepValue	The increment for each step.

Definition at line 58 of file progress_indicator_spin.h.

                                                         : 
         progress_indicator_terminal(title, description, minRange, maxRange, stepValue), m_symbols(NULL), m_numberOfStates(0), m_state(0) {
         m_numberOfStates = 4;
         m_symbols = new char[m_numberOfStates+2];
         m_symbols[0] = '|';
         m_symbols[1] = '/';
         m_symbols[2] = '-';
         m_symbols[3] = '\\';
         m_symbols[4] = 'X';
         m_symbols[5] = '\0';
     }

References m_numberOfStates, and m_symbols.

◆ progress_indicator_spin() [2/2]

tpie::progress_indicator_spin::progress_indicator_spin ( const progress_indicator_spin & other )

inline

Copy-constructor.

Definition at line 78 of file progress_indicator_spin.h.

                                                                   : 
         progress_indicator_terminal(other), m_symbols(NULL), m_numberOfStates(0), m_state(0) {
         *this = other;
     }

◆ ~progress_indicator_spin()

virtual tpie::progress_indicator_spin::~progress_indicator_spin ( )

inlinevirtual

The destructor.

Nothing is done.

Definition at line 109 of file progress_indicator_spin.h.

                                        {
         delete [] m_symbols;
     };

References m_symbols.

Member Function Documentation

◆ display_percentage()

void tpie::progress_indicator_terminal::display_percentage ( )

inlineprotectedinherited

Compute and print the percentage or step count.

Definition at line 139 of file progress_indicator_terminal.h.

     {
         //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 << '%';
     }

References tpie::progress_indicator_base::m_current, and tpie::progress_indicator_base::m_range.

Referenced by tpie::progress_indicator_terminal::refresh().

◆ done()

void tpie::progress_indicator_terminal::done ( )

inlinevirtualinherited

Advance the indicator to the end.

Reimplemented from tpie::progress_indicator_base.

Definition at line 95 of file progress_indicator_terminal.h.

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

References tpie::progress_indicator_base::m_current, tpie::progress_indicator_base::m_range, and tpie::progress_indicator_terminal::refresh().

◆ get_current()

stream_size_type tpie::progress_indicator_base::get_current ( )

inlineinherited

Get the current value of the step counter.

Definition at line 152 of file progress_indicator_base.h.

152 { return m_current; }

◆ get_range()

stream_size_type tpie::progress_indicator_base::get_range ( )

inlineinherited

Get the maximum value of the current range.

Definition at line 157 of file progress_indicator_base.h.

157 { return m_range; }

◆ init()

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_subindicator, and tpie::progress_indicator_null.

Definition at line 121 of file progress_indicator_base.h.

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

Referenced by tpie::merge_sorter< T, UseProgress, pred_t, store_t >::calc(), and tpie::parallel_sort().

◆ operator=()

progress_indicator_spin& tpie::progress_indicator_spin::operator= ( const progress_indicator_spin & other )

inline

Assignment operator.

Definition at line 87 of file progress_indicator_spin.h.

                                                                              {
         if (this != &other) {
  
         progress_indicator_terminal::operator=(other);
  
         m_numberOfStates = other.m_numberOfStates;
         m_state          = other.m_state;
         
         delete[] m_symbols;
  
         m_symbols = new char[m_numberOfStates+2];
         memcpy(m_symbols, other.m_symbols, m_numberOfStates+2);
         }
         return *this;
     }

References m_numberOfStates, m_state, and m_symbols.

◆ raw_step()

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

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

◆ refresh()

virtual void tpie::progress_indicator_spin::refresh ( )

inlinevirtual

Display the indicator.

Reimplemented from tpie::progress_indicator_terminal.

Definition at line 119 of file progress_indicator_spin.h.

                            {
         m_state = ++m_state % m_numberOfStates;
  
         //  Use the last symbol for indicating "done".
         if (m_current == m_maxRange) m_state = m_numberOfStates;
  
         //  Go to the beginning of the line and print the description.
         std::cout << "\r" << m_description << " " << m_symbols[m_state] << std::flush;
     }

References tpie::progress_indicator_base::m_current, m_numberOfStates, m_state, and m_symbols.

◆ set_range()

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

                                                    {
         m_range = range;
     }

◆ set_title()

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 112 of file progress_indicator_terminal.h.

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

References tpie::progress_indicator_terminal::m_title.

◆ step()

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

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

Referenced by tpie::merge_sorter< T, UseProgress, pred_t, store_t >::calc(), and tpie::ami::Internal_Sorter_Obj< T, Compare >::sort().

Member Data Documentation

◆ m_current

stream_size_type tpie::progress_indicator_base::m_current

protectedinherited

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

Definition at line 174 of file progress_indicator_base.h.

Referenced by tpie::progress_indicator_terminal::display_percentage(), tpie::progress_indicator_terminal::done(), tpie::progress_indicator_arrow::refresh(), refresh(), and tpie::progress_indicator_arrow::reset().

◆ m_numberOfStates

unsigned short tpie::progress_indicator_spin::m_numberOfStates

protected

The number of characters used for the spinning indicator.

Definition at line 135 of file progress_indicator_spin.h.

Referenced by operator=(), progress_indicator_spin(), and refresh().

◆ m_range

stream_size_type tpie::progress_indicator_base::m_range

protectedinherited

The upper bound of the counting range.

Definition at line 171 of file progress_indicator_base.h.

Referenced by tpie::progress_indicator_terminal::display_percentage(), tpie::progress_indicator_terminal::done(), and tpie::progress_indicator_arrow::refresh().

◆ m_state

unsigned short tpie::progress_indicator_spin::m_state

protected

The current character used for the spinning indicator.

Definition at line 138 of file progress_indicator_spin.h.

Referenced by operator=(), and refresh().

◆ m_symbols

char* tpie::progress_indicator_spin::m_symbols

protected

The characters used for the spinning indicator.

Definition at line 132 of file progress_indicator_spin.h.

Referenced by operator=(), progress_indicator_spin(), refresh(), and ~progress_indicator_spin().

◆ m_title

std::string tpie::progress_indicator_terminal::m_title

protectedinherited

A string holding the description of the title.

Definition at line 155 of file progress_indicator_terminal.h.

Referenced by tpie::progress_indicator_arrow::refresh(), tpie::progress_indicator_terminal::refresh(), and tpie::progress_indicator_terminal::set_title().

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

progress_indicator_spin.h

TPIE

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ progress_indicator_spin() [1/2]

◆ progress_indicator_spin() [2/2]

◆ ~progress_indicator_spin()

Member Function Documentation

◆ display_percentage()

◆ done()

◆ get_current()

◆ get_range()

◆ init()

◆ operator=()

◆ raw_step()

◆ refresh()

◆ set_range()

◆ set_title()

◆ step()

Member Data Documentation

◆ m_current

◆ m_numberOfStates

◆ m_range

◆ m_state

◆ m_symbols

◆ m_title