X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FmodelCDMLib.h;h=e372e5f887f9455e7ed3d36e7f09e46f332eca66;hb=698d779d5af904401fa3640f9a2e1c9a3f4aad28;hp=520822f09ab47d5b842bc80c923a98d1aa613586;hpb=e2223b619fa37daaf6103b34b39e789efc1a0b94;p=crea.git diff --git a/lib/creaDevManagerLib/modelCDMLib.h b/lib/creaDevManagerLib/modelCDMLib.h index 520822f..e372e5f 100644 --- a/lib/creaDevManagerLib/modelCDMLib.h +++ b/lib/creaDevManagerLib/modelCDMLib.h @@ -37,25 +37,68 @@ #include #include +#include -#include "modelCDMIProjectTreeNode.h" +#include "modelCDMFolder.h" #include "modelCDMLibrary.h" -class modelCDMLib : public modelCDMIProjectTreeNode +/** + * Class representing the lib folder of a Crea project. + */ +class modelCDMLib : public modelCDMFolder { public: + /** + * Default Constructor. + */ modelCDMLib(); + /** + * Lib folder node constructor. + * @param parent Parent node of the lib folder node. + * @param path Full path to the lib folder node. + * @param name Name of the lib folder node. By default "lib". + * @param level Project hierarchy level of the lib folder node. + */ + modelCDMLib(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name = "lib", const int& level = 1); + /** + * Destructor. + */ ~modelCDMLib(); - bool CreateLibrary( + /** + * Returns the libraries registered in the lib folder. + * @return Array of library references. + */ + const std::vector& GetLibraries() const; + + /** + * Creates a new library node for the actual project and registers it. It modifies the project model as well as the system. + * @param name Name of the new library. + * @param result Result message. + * @return New library reference. + */ + modelCDMLibrary* CreateLibrary( const std::string& name, - std::string*& result, - const std::string& path = "/" + std::string*& result ); - bool OpenCMakeListsFile(std::string*& result); - bool Refresh(std::string*& result); + + /** + * Refreshes the structure of the lib folder. Deletes folders and files deleted since the las refresh and Adds folders and files created since the las refresh. + * @param result Result message. + * @return True if the operation was successful. + */ + virtual const bool Refresh(std::string*& result); + + /** + * Checks the file structure and the CMakeLists file to find structure definition errors before compiling the project. + * @param properties Properties of the project. + */ + void CheckStructure(std::map& properties); private: + /** + * Libraries references. + */ std::vector libraries; };