src2/creaImageIOTreeHandlerImageAdder.h

   1 #ifndef __creaImageIOTreeHandlerImageAdder_h_INCLUDED__
   2 #define __creaImageIOTreeHandlerImageAdder_h_INCLUDED__
   3
   4 #include <creaImageIOTreeHandler.h>
   5 #include <creaImageIOImageReader.h>
   6 #include <wx/wx.h>
   7 #include <wx/progdlg.h>
   8 // Signal/slot mechanism for progress events
   9 #include <boost/signal.hpp>
  10 #include <boost/bind.hpp>
  11
  12
  13 namespace creaImageIO
  14 {
  15         /**
  16         * \ingroup Model
  17         */
  18
  19   //=======================================================================
  20   /// Object which can add images files to a TreeHandler. Is able to parse (recursively) a part of a filesystem to look for known images and load their attributes in order to add the images to a Tree (submission via a TreeHandler::AddBranch)
  21
  22   class TreeHandlerImageAdder
  23   {
  24   public:
  25     //====================================================================
  26     /// Ctor
  27     TreeHandlerImageAdder(TreeHandler* tree);
  28     /// Dtor
  29     ~TreeHandlerImageAdder();
  30     /// Sets the TreeHandler
  31     void SetTreeHandler(TreeHandler* tree) { mTreeHandler = tree;}
  32     //====================================================================
  33
  34     //====================================================================
  35     /// Structure which holds progress information
  36     /// To stop the image adder use SetStop()
  37     class Progress
  38     {
  39     public:
  40       Progress() { Reset(); }
  41       ~Progress() {}
  42
  43       void Reset()
  44       {
  45         mStop = false;
  46         mNumberScannedFiles = 0;
  47         mNumberScannedDirs = 0;
  48         mNumberHandledFiles = 0;
  49         mNumberAddedFiles = 0;
  50       }
  51
  52       int GetNumberScannedFiles() { return mNumberScannedFiles; }
  53       int GetNumberScannedDirs() { return mNumberScannedDirs; }
  54       int GetNumberHandledFiles() { return mNumberHandledFiles; }
  55       int GetNumberAddedFiles() { return mNumberAddedFiles; }
  56
  57       void IncNumberScannedFiles() { mNumberScannedFiles++; }
  58       void IncNumberScannedDirs() { mNumberScannedDirs++; }
  59       void IncNumberHandledFiles() { mNumberHandledFiles++; }
  60       void IncNumberAddedFiles() { mNumberAddedFiles++; }
  61
  62       void SetStop() { mStop = true; }
  63       bool GetStop() { return mStop; }
  64
  65     private:
  66       bool mStop;
  67       int mNumberScannedFiles;
  68       int mNumberScannedDirs;
  69       int mNumberHandledFiles;
  70       int mNumberAddedFiles;
  71     };
  72     //=============================================
  73
  74     //=============================================
  75     const Progress& GetProgress() const { return mProgress; }
  76     //=============================================
  77
  78     //=============================================
  79     //    typedef boost::signals::trackable ProgressObserverType;
  80     typedef boost::signal<void (Progress&)>  ProgressSignalType;
  81     typedef ProgressSignalType::slot_function_type ProgressCallbackType;
  82     //=============================================
  83
  84    //==================================================================
  85     /// Adds the function f to the list of functions to call
  86     /// when the addition progresses.
  87     /// f is of type ProgressCallbackType which is:
  88     /// void (*ProgressCallbackType)(Progress&)
  89     /// To pass a member function 'f' of an instance 'c' of a class 'C'
  90     /// as callback you have to 'bind' it, i.e. call:
  91     /// ConnectProgressObserver ( boost::bind( &C::f , c, _1 ) );
  92     void ConnectProgressObserver(ProgressCallbackType callback);
  93    //==================================================================
  94
  95     //====================================================================
  96     /// Returns if the file can be read or not
  97     bool IsHandledFile( const std::string& filename);
  98     /// Adds a list of files to the TreeHandler
  99     void AddFiles( const std::vector<std::string>& filename );
 100     /// (Recursively) adds the files of a directory to the TreeHandler
 101     void AddDirectory( const std::string& directory,
 102                        bool recurse );
 103     //====================================================================
 104
 105   private:
 106
 107     /// Adds a single file to the TreeHandler
 108     /// **WITHOUT** testing werther it is handled or not
 109     /// hence you have to call IsHandledFile before using AddFile!
 110     void AddFile( const std::string& filename );
 111
 112     /// Recursive method which does the main job for AddDirectory
 113     void AddDirectoryRecursor( const std::string& directory,
 114                                bool recurse );
 115
 116
 117     TreeHandler* mTreeHandler;
 118     ImageReader mReader;
 119
 120     Progress mProgress;
 121     ProgressSignalType mProgressSignal;
 122   };
 123   // EO class TreeHandlerImageAdder
 124   //=======================================================================
 125
 126
 127 } // EO namespace creaImageIO
 128
 129 // EOF
 130 #endif
 131