E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIPIManager.hpp

Go to the documentation of this file.

/*
TerraLib - a library for developing GIS applications.
Copyright  2001, 2002, 2003 INPE and Tecgraf/PUC-Rio.

This code is part of the TerraLib library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

You should have received a copy of the GNU Lesser General Public
License along with this library.

The authors reassure the license terms regarding the warranties.
They specifically disclaim any warranties, including, but not limited to,
the implied warranties of merchantability and fitness for a particular
purpose. The library provided hereunder is on an "as is" basis, and the
authors have no obligation to provide maintenance, support, updates,
enhancements, or modifications.
In no event shall INPE be held liable to any party
for direct, indirect, special, incidental, or consequential damages arising
out of the use of this library and its documentation.
*/

#ifndef TEPDIPIMANAGER_HPP
  #define TEPDIPIMANAGER_HPP
  
  #include "TePDIPIManagerGlobalSettings.hpp"
  
  #include "../kernel/TeProgress.h"
  
  #include <string>

  class PDI_DLL TePDIPIManager {
  
    public :
    
      TePDIPIManager( const std::string& message = std::string(), 
        unsigned long int tsteps = 0, bool enabled = false );    
    
      ~TePDIPIManager();
      
      void Toggle( bool enabled );  
      
      bool Update( unsigned long int step );      
      
      inline bool Increment()
      {
        return Update( (int)( curr_step_ + 1 ) );
      };

      void Reset( const std::string& message = std::string(), 
        unsigned long int tsteps = 0 );
        
      inline bool wasCanceled()
      {
        return ( prog_intef_ptr_ ? prog_intef_ptr_->wasCancelled() : false );
      };         
        
    protected :
    
      bool enabled_;    

      unsigned long int total_steps_;

      unsigned long int curr_step_;
      
      TePDIPIManagerGlobalSettings& global_settings_;
      
      TeProgressBase* prog_intef_ptr_;
      
      std::string message_;    
     
      bool updateProgressInterface() const;
        
    private :
    
      TePDIPIManager( const TePDIPIManager& );
      
      const TePDIPIManager& operator=( const TePDIPIManager& ) 
      { 
        return *this;
      };
  };

#endif