src/utl/utlProgress.h

   1 //-----------------------------------------------------------------------------
   2 // This file is a part of the Qanava and LTM software.
   3 //
   4 // \file        utlProgress.h
   5 // \author      Benoit Autheman (benoit@faktiss.net)
   6 // \date        2005 July 08
   7 //-----------------------------------------------------------------------------
   8
   9
  10 #ifndef qan_utlProgress_h
  11 #define qan_utlProgress_h
  12
  13
  14 // UTL headers
  15 #include "./utlConfig.h"
  16
  17
  18 //-----------------------------------------------------------------------------
  19 namespace QAN_UTL_ROOT_NAMESPACE // ::QAN_UTL_ROOT_NAMESPACE
  20 {
  21         namespace utl // ::QAN_UTL_ROOT_NAMESPACE::utl
  22         {
  23                 //! Abstract class used to provide feedback about a task progression.
  24                 /*!
  25                         \nosubgrouping
  26                 */
  27                 class Progress
  28                 {
  29                         /*! \name Progress Constructor/Destructor *///------------------------
  30                         //@{
  31                 public:
  32
  33                         //! Progress constructor.
  34                         Progress( int maxProgress = 100 ) :
  35                                 _progress( 0 ),
  36                                 _maxProgress( maxProgress ) { }
  37
  38                         //! Progress destructor.
  39                         virtual ~Progress( ) { }
  40
  41                 protected:
  42
  43                         //! Progress empty private copy constructor.
  44                         Progress( const Progress& progress ) { }
  45                         //@}
  46                         //-----------------------------------------------------------------
  47
  48
  49
  50                         /*! \name Progress Management *///---------------------------------
  51                         //@{
  52                 public:
  53
  54                         //! .
  55                         void                    reset( int maxProgress );
  56
  57                         //! .
  58                         void                    setProgress( int progress )
  59                         {
  60                                 _progress = progress;
  61                                 if ( _maxProgress != 0 )
  62                                         updateProgress( progress * 100 / _maxProgress );
  63                         }
  64
  65                         //! .
  66                         int                             getProgress( ) const { return _progress; }
  67
  68                         //! .
  69                         void                    incProgress( ) { setProgress( getProgress( ) + 1 ); }
  70
  71                         //! .
  72                         virtual void    setMaxProgress( int maxProgress ) { _maxProgress = maxProgress; }
  73
  74                         //! .
  75                         virtual bool    getCancel( ) = 0;
  76
  77                         //! .
  78                         void                    finish( ) { setProgress( _maxProgress ); }
  79
  80                 protected:
  81
  82                         //!
  83                         virtual void    updateProgress( int percent ) = 0;
  84
  85                         //! .
  86                         int                             _progress;
  87
  88                         //! .
  89                         int                             _maxProgress;
  90                         //@}
  91                         //-----------------------------------------------------------------
  92                 };
  93
  94
  95
  96                 //! Progress default concrete implementation.
  97                 /*!
  98                         \nosubgrouping
  99                 */
 100                 class ProgressVoid : public Progress
 101                 {
 102                         /*! \name Progress Management *///---------------------------------
 103                         //@{
 104                 public:
 105
 106                         //! .
 107                         virtual bool    getCancel( ) { return false; }
 108
 109                 protected:
 110
 111                         //! .
 112                         virtual void    updateProgress( int /*percent*/ ) { }
 113                         //@}
 114                         //-----------------------------------------------------------------
 115                 };
 116         } // ::QAN_UTL_ROOT_NAMESPACE::utl
 117 } // ::QAN_UTL_ROOT_NAMESPACE
 118 //-----------------------------------------------------------------------------
 119
 120
 121 #endif // qan_utlProgress_h
 122