]> Creatis software - creaImageIO.git/blob - src2/creaImageIOGimmick.h
5b6606ce679a18acfb36eb829c49281748e57f61
[creaImageIO.git] / 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 <creaImageIOSynchronizer.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 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         ///Synchronizes the loaded data with the database. If remove is true the database will be updated, otherwise 
95         ///only a warning sign will be issued
96         void Synchronize(bool update, TreeHandler* handler);
97
98     /// Prints the tree handled by the handler
99     void Print(const std::string& handler);
100
101
102     /// Returns the TreeHandler with a given name
103     TreeHandler* GetTreeHandler(const std::string& name) const;
104
105         /// Returns the TimestampDatabase
106         TimestampDatabaseHandler* GetTimestampDatabase() const;
107     /// 
108     SQLiteTreeHandler* GetLocalDatabase() { return mLocalDatabase; }
109
110     const SQLiteTreeHandler* GetLocalDatabase() const 
111     { return mLocalDatabase; }
112
113     
114
115     /// 
116     const std::string& GetHomeDirectory();
117     const std::string& GetUserSettingsDirectory();
118     void CreateUserSettingsDirectory();
119     const std::string& GetLocalDatabasePath();
120         const std::string& GetTimestampDatabasePath();
121
122
123     //=============================================
124   private:
125     SQLiteTreeHandler* mLocalDatabase;
126         TimestampDatabaseHandler* mTimestampDatabase;
127     TreeHandlerMapType mTreeHandlerMap;
128         Synchronizer* mSynchronizer;
129
130     std::string mCurrentDirectory;
131     std::string mHomeDirectory;
132     std::string mUserSettingsDirectory;
133     std::string mLocalDatabasePath;
134         std::string mTimestampDatabasePath;
135
136     TreeHandlerImageAdder mImageAdder;
137   };
138   // EO class Gimmick
139   //=======================================================================
140
141
142 } // EO namespace creaImageIO
143
144 // EOF
145 #endif  
146
147