src2/creaImageIOGimmick.h

   1 #ifndef __creaImageIOGimmick_h_INCLUDED__
   2 #define __creaImageIOGimmick_h_INCLUDED__
   3
   4 #include <creaImageIOSQLiteTreeHandler.h>
   5 #include <creaImageIOTreeHandlerImageAdder.h>
   6 #include <creaImageIOTimestampDatabaseHandler.h>
   7 #include <creaImageIOSynchron.h>
   8
   9 namespace creaImageIO
  10 {
  11         /**
  12         * \defgroup Controller Controller
  13         */
  14         /**
  15         * \defgroup View View
  16         */
  17         /**
  18         * \defgroup Model Model
  19         */
  20         /**
  21         * \defgroup GUI Top level graphical user interfaces
  22         */
  23         /**
  24         * \defgroup IO Image I/O classes
  25         */
  26         /**
  27         * \defgroup Tree Attributed tree management
  28         */
  29         /**
  30         * \defgroup Previewer Preview related
  31         */
  32
  33         /**
  34         * \ingroup Controller
  35         */
  36
  37   //=======================================================================
  38   /// Central controler of the gimmick application
  39   class CREAIMAGEIO_EXPORT Gimmick
  40   {
  41   public:
  42     /// Ctor
  43     Gimmick();
  44     /// Dtor
  45     ~Gimmick();
  46
  47     ///
  48     typedef TreeHandlerImageAdder::Progress AddProgress;
  49     typedef TreeHandlerImageAdder::ProgressCallbackType AddProgressCallbackType;
  50
  51     /// Adds the function f to the list of functions to call
  52     /// when addition operations progres.
  53     /// f is of type AddProgressCallbackType which is:
  54     /// void (*AddProgressCallbackType)(AddProgress&)
  55     /// To pass a member function 'f' of an instance 'c' of a class 'C'
  56     /// as callback you have to 'bind' it, i.e. call:
  57     /// ConnectAddProgressObserver ( boost::bind( &C::f , c, _1 ) );
  58      void ConnectAddProgressObserver( AddProgressCallbackType callback )
  59     { mImageAdder.ConnectProgressObserver(callback); }
  60
  61
  62     ///
  63     const AddProgress& GetAddProgress() const { return mImageAdder.GetProgress(); }
  64
  65     /// Initialize (read/creates databases, etc.)
  66     void Initialize();
  67
  68     /// Finalize (closes databases, etc.)
  69     void Finalize();
  70
  71     /// Sets level for messages "Gimmick!"
  72     static void SetMessageLevel(int level);
  73     /// Sets level for debug messages "Gimmick! DEBUG"
  74     static void SetDebugMessageLevel(int level);
  75
  76     /// Type of map from TreeHandler name to TreeHandler*
  77     typedef std::map<std::string, TreeHandler*> TreeHandlerMapType;
  78
  79     /// Returns the TreeHandlerMap (ref)
  80     TreeHandlerMapType& GetTreeHandlerMap() { return mTreeHandlerMap; }
  81     /// Returns the TreeHandlerMap (const ref)
  82     const TreeHandlerMapType& GetTreeHandlerMap() const
  83     { return mTreeHandlerMap; }
  84
  85
  86     /// Add the files to the given TreeHandler
  87     void AddFiles(const std::string& handler,
  88                   const std::vector<std::string>& filenames);
  89
  90     /// Add a dir to the given TreeHandler
  91     void AddDir(const std::string& handler, const std::string& path,
  92                 bool recurse);
  93
  94         /// Removes a file from the given TreeHandler
  95         void RemoveFile(const std::string& d,
  96                         tree::Node* filename);
  97
  98         ///Synchronizes the loaded data with the database. If remove is true the database will be updated, otherwise
  99         ///only a warning sign will be issued
 100         std::string Synchronize(bool repair, bool checkAttributes);
 101
 102     /// Prints the tree handled by the handler
 103     void Print(const std::string& handler);
 104
 105     ///create a DB from a given descriptor file and for a specific location
 106     SQLiteTreeHandler *createDB(const std::string &i_name,
 107                                 const std::string &i_locDesc,
 108                                 const std::string &i_locDB);
 109
 110         // add an existent DB
 111         void addDB(const std::string &i_nameDB, const std::string &i_locationDB);
 112
 113     /// Returns the TreeHandler with a given name
 114     TreeHandler* GetTreeHandler(const std::string& name) const;
 115
 116         /// Returns the TimestampDatabase
 117         TimestampDatabaseHandler* GetTimestampDatabase() const;
 118     ///
 119     SQLiteTreeHandler* GetLocalDatabase() { return mLocalDatabase; }
 120
 121     const SQLiteTreeHandler* GetLocalDatabase() const
 122     { return mLocalDatabase; }
 123
 124
 125
 126     ///
 127     const std::string& GetHomeDirectory();
 128     const std::string& GetUserSettingsDirectory();
 129     void CreateUserSettingsDirectory();
 130     const std::string& GetLocalDatabasePath();
 131         const std::string& GetTimestampDatabasePath();
 132
 133
 134     //=============================================
 135   private:
 136     SQLiteTreeHandler* mLocalDatabase;
 137         TimestampDatabaseHandler* mTimestampDatabase;
 138     TreeHandlerMapType mTreeHandlerMap;
 139         Synchronizer* mSynchronizer;
 140
 141     std::string mCurrentDirectory;
 142     std::string mHomeDirectory;
 143     std::string mUserSettingsDirectory;
 144     std::string mLocalDatabasePath;
 145         std::string mTimestampDatabasePath;
 146
 147     TreeHandlerImageAdder mImageAdder;
 148   };
 149   // EO class Gimmick
 150   //=======================================================================
 151
 152
 153 } // EO namespace creaImageIO
 154
 155 // EOF
 156 #endif
 157
 158