cmtkProgress.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2296 $
//
//  $LastChangedDate: 2010-08-25 16:23:03 -0700 (Wed, 25 Aug 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkProgress_h_included_
#define __cmtkProgress_h_included_

#include <cmtkconfig.h>

#include <string>
#include <queue>

namespace
cmtk
{


class Progress 
{
public:
  typedef enum {
    OK,
    INTERRUPT,
    TIMEOUT,
    FAILED
  } ResultEnum;  

  typedef Progress Self;

  Progress()
  {
    Self::SetProgressInstance( this );
  }

  virtual ~Progress() {};
  
  static void Begin( const double start, const double end, const double increment, const std::string& taskName = std::string("") );

  static ResultEnum SetProgress( const double progress );

  static void Done();

  virtual ResultEnum UpdateProgress() = 0;
  
  void SetProgressCurrent( const double progress );
  
  static void SetProgressInstance( Self *const progressInstance ) 
  {
    Self::ProgressInstance = progressInstance;
  }
  
protected:
  bool IsTopLevel() const
  {
    return m_RangeStack.size() == 1;
  }

  const std::string GetCurrentTaskName() const;

  double GetFractionComplete() const;

  virtual void BeginVirtual( const double start, const double end, const double increment, const std::string& taskName = std::string("") );

  virtual void DoneVirtual();

private:
  static Self* ProgressInstance;

  class Range
  {
  public:
    Range( const double start, const double end, const double increment, const std::string& taskName = std::string("") )
      : m_Start( start ), m_End( end ), m_Increment( increment ), m_TaskName( taskName )
    {
      this->m_Current = this->m_Start;
    }

    double GetFractionComplete( const double nestedFraction = 0 
      ) const;

    double m_Start;

    double m_End;

    double m_Increment;

    double m_Current;

    const std::string m_TaskName;
  };

  typedef std::deque<Self::Range> RangeStackType;

  RangeStackType m_RangeStack;
};


} // namespace cmtk

#endif // #ifndef __cmtkProgress_h_included_