X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src2%2FcreaImageIOGimmick.h;h=4e7ec07efaeb9f3fa9a69685e572791105ea14f3;hb=a90aea2310e662216062acb6c548116958a3cc1d;hp=7a984a39987daef964e955ee3e752b7242362da8;hpb=cbf693fa62cd51f4ca5c881838bbb609edc447b0;p=creaImageIO.git diff --git a/src2/creaImageIOGimmick.h b/src2/creaImageIOGimmick.h index 7a984a3..4e7ec07 100644 --- a/src2/creaImageIOGimmick.h +++ b/src2/creaImageIOGimmick.h @@ -2,13 +2,41 @@ #define __creaImageIOGimmick_h_INCLUDED__ #include +#include +#include +#include namespace creaImageIO { + /** + * \defgroup Controller Controller + */ + /** + * \defgroup View View + */ + /** + * \defgroup Model Model + */ + /** + * \defgroup GUI Top level graphical user interfaces + */ + /** + * \defgroup IO Image I/O classes + */ + /** + * \defgroup Tree Attributed tree management + */ + /** + * \defgroup Previewer Preview related + */ + + /** + * \ingroup Controller + */ //======================================================================= /// Central controler of the gimmick application - class Gimmick + class CREAIMAGEIO_EXPORT Gimmick { public: /// Ctor @@ -16,27 +44,128 @@ namespace creaImageIO /// Dtor ~Gimmick(); - /// Initialize (read/creates databases, etc.) - bool Initialize(); + /// + typedef TreeHandlerImageAdder::Progress AddProgress; + typedef TreeHandlerImageAdder::ProgressCallbackType AddProgressCallbackType; + + /// Adds the function f to the list of functions to call + /// when addition operations progres. + /// f is of type AddProgressCallbackType which is: + /// void (*AddProgressCallbackType)(AddProgress&) + /// To pass a member function 'f' of an instance 'c' of a class 'C' + /// as callback you have to 'bind' it, i.e. call: + /// ConnectAddProgressObserver ( boost::bind( &C::f , c, _1 ) ); + void ConnectAddProgressObserver( AddProgressCallbackType callback ) + { mImageAdder.ConnectProgressObserver(callback); } + + /// + const AddProgress& GetAddProgress() const { return mImageAdder.GetProgress(); } + + /// Initializes with default values (read/creates databases, etc.) + void Initialize(); + + /// Initializes with the local database descriptor in the path given (read/creates databases, etc.) + void Initialize(const std::string& path); /// Finalize (closes databases, etc.) - bool Finalize(); + void Finalize(); + + /// Sets level for messages "Gimmick!" + static void SetMessageLevel(int level); + /// Sets level for debug messages "Gimmick! DEBUG" + static void SetDebugMessageLevel(int level); + + /// Type of map from TreeHandler name to TreeHandler* + typedef std::map TreeHandlerMapType; + + /// Returns the TreeHandlerMap (ref) + TreeHandlerMapType& GetTreeHandlerMap() { return mTreeHandlerMap; } + /// Returns the TreeHandlerMap (const ref) + const TreeHandlerMapType& GetTreeHandlerMap() const + { return mTreeHandlerMap; } + + /// Add the files to the given TreeHandler + void AddFiles(const std::string& handler, + const std::vector& filenames); + + /// Add a dir to the given TreeHandler + void AddDir(const std::string& handler, const std::string& path, + bool recurse); + + /// Removes a file from the given TreeHandler + void RemoveFile(const std::string& d, + tree::Node* filename); + + ///Deletes the given drive name from the databases + void DeleteDrive(const std::string& drive); + + /// Copies the files into the local directory + void CopyFiles(const std::vector& filenames, const std::string& d ); + + ///Synchronizes the loaded data with the database d. If repair is true the database will be updated, otherwise + ///only a warning sign will be issued + std::string Synchronize(const std::string& d, bool repair, bool checkAttributes); + /// Prints the tree handled by the handler + void Print(const std::string& handler); + + ///create a DB from a given descriptor file and for a specific location + SQLiteTreeHandler *createDB(const std::string &i_name, + const std::string &i_locDesc, + const std::string &i_locDB); + + /// add an existent DB + void addDB(const std::string &i_nameDB, const std::string &i_locationDB); + + /// Returns the TreeHandler with a given name + TreeHandler* GetTreeHandler(const std::string& name) const; + + /// + SQLiteTreeHandler* GetLocalDatabase() { return mLocalDatabase; } + + const SQLiteTreeHandler* GetLocalDatabase() const + { return mLocalDatabase; } + + ///Returns the given setting value for the given setting parameter + void GetSetting(const std::string& name, std::string& value); + + ///Updates the settings file + void UpdateSetting(const std::string& name, const std::string& value); + + /// add DB from Settings file + void addDBSettings(); + + ///Edits the field described by the name and key provided with the value given + void EditField(tree::Node* node, const std::string& d, const std::string& name, const std::string& key, const std::string& val); + + /// Returns the attributes in results described in params + void GetAttributes(const std::string& d, + const std::string& filename, + const std::vector& params, + std::vector& results); + + /// const std::string& GetHomeDirectory(); const std::string& GetUserSettingsDirectory(); - bool CreateUserSettingsDirectory(); + void CreateUserSettingsDirectory(); const std::string& GetLocalDatabasePath(); + + + //============================================= private: SQLiteTreeHandler* mLocalDatabase; - + TreeHandlerMapType mTreeHandlerMap; + Synchronizer* mSynchronizer; + std::string mCurrentDirectory; std::string mHomeDirectory; std::string mUserSettingsDirectory; std::string mLocalDatabasePath; - + Settings *mSettings; + TreeHandlerImageAdder mImageAdder; }; // EO class Gimmick //=======================================================================