ProgressIndicator.h

Go to the documentation of this file.

/******************************************************************************
 *
 *  Copyright (C) 2008 Max Hermann
 *
 *  This file is part of the "CEDRIC Event Display" application.
 *
 *****************************************************************************/

#ifndef PROGRESSINDICATOR_H
#define PROGRESSINDICATOR_H

#include <string>

class ProgressIndicator
{
public:
        ProgressIndicator( int min=0, int max=100 )
        : m_progress( min ),
          m_canceled( false ),
          m_minValue( min ),
          m_maxValue( max )
                {
                }
        
        virtual ~ProgressIndicator() 
                {}

protected:
        virtual bool onPoll()=0;
        virtual void onStart()=0;
        virtual void onFinish()=0;                      
        virtual void onRangeChange( int /*min*/, int /*max*/ ) {};
        
public:
        bool poll( int progress )
                {
                        m_progress = progress;
                        m_canceled = !onPoll();
                        return !m_canceled;
                }

        void start() 
                { 
                        m_canceled = false;
                        m_progress  = m_minValue;
                        onStart();
                }
        
        void finish()
                {
                        m_progress = m_maxValue;
                        poll( m_progress );
                        onFinish();
                }
        
        void step()
                {
                        poll( m_progress+1 );
                }
        
        void setRange( int min, int max )
                {
                        m_minValue = min;
                        m_maxValue = max;
                        onRangeChange( min, max );
                }
                
        virtual void setTitle( const std::string& title )
                {
                        m_title = title;
                }
                
        virtual void setLabel( const std::string& label )
                {
                        m_label = label;
                }

        float percentage() const
                {
                        return (m_progress-m_minValue) / (float)m_maxValue;
                }
        
        //## refactor wasCanceled() to canceled() ?
        bool wasCanceled() const { return m_canceled; }
        int  progress   () const { return m_progress; }
        int  minValue   () const { return m_minValue; }
        int  maxValue   () const { return m_maxValue; }
        
        std::string  title() const { return m_title; }
        std::string& title()       { return m_title; }
        std::string  label() const { return m_label; }
        std::string& label()       { return m_label; }

protected:
        int  m_progress;
        bool m_canceled;
        int  m_minValue;
        int  m_maxValue;

        std::string m_title;
        std::string m_label;
};


#include <iostream>
#include <iomanip>

class ConsoleProgressIndicator: public ProgressIndicator
{
public:
        ConsoleProgressIndicator()
        : ProgressIndicator(),
          m_cr('\r')
                {}

protected:
        void onStart () {}              
        void onFinish() { std::cout << std::endl; }             
        
        bool onPoll()
                {
                        std::cout << title() << ": "
                                << std::setprecision(3) << std::setw(4)
                                << percentage()*100 << "% ";
                        
                        if( !label().empty() )
                                std::cout << "(" << label() << ")   ";
                        
                        std::cout << m_cr;
                        
                        // cancel not possible yet
                        return true;
                }

private:
        char m_cr;
};

#endif // PROGRESSINDICATOR_H