X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FmodelCDMMain.h;h=d028487404e97f36190ad0975ad90eebdda826bb;hb=38fb78e3930c8ba01021536630624e4b0b03dd87;hp=d72d3b2430dd36209562c974004d4f0076495e26;hpb=ca800a1a9a78f119d37d9642ea29acb7c9b9a323;p=crea.git diff --git a/lib/creaDevManagerLib/modelCDMMain.h b/lib/creaDevManagerLib/modelCDMMain.h index d72d3b2..d028487 100644 --- a/lib/creaDevManagerLib/modelCDMMain.h +++ b/lib/creaDevManagerLib/modelCDMMain.h @@ -2,7 +2,7 @@ # --------------------------------------------------------------------- # # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image -# pour la Santé) +# pour la Sant�) # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton # Previous Authors : Laurent Guigues, Jean-Pierre Roux # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil @@ -23,33 +23,107 @@ # The fact that you are presently reading this means that you have had # knowledge of the CeCILL-B license and that you accept its terms. # ------------------------------------------------------------------------ -*/ - - + */ /* * modelCDMMain.h * * Created on: 13/11/2012 - * Author: daniel + * Author: Daniel Felipe Gonzalez Obando */ #ifndef MODELCDMMAIN_H_ #define MODELCDMMAIN_H_ +#include +#include + +#include +#include + +#include "modelCDMIProjectTreeNode.h" #include "modelCDMProject.h" +/** + * Class representing the model of the project manager. + */ class modelCDMMain { public: + /** + * Default constructor. + */ modelCDMMain(); + /** + * Destructor. + */ ~modelCDMMain(); - modelCDMProject* GetProject(); - void SetProject(modelCDMProject* project); + /** + * Retrieves the current active project. + * @return Reference to the current active project, if there's no active project NULL is returned. + */ + modelCDMProject* GetProject() const; + /** + * Retrieves the map of all the nodes inside the current active project. + * @return Map with ids and node reference of the project. + */ + std::map< wxCDMTreeItemId, modelCDMIProjectTreeNode* >& GetModelElements(); + + + /** + * Creates a new project and sets it as the current active project. This method creates a new project model and also creates a project in the system. + * @param name Name of the new project. + * @param location Path where the project is to be created. + * @param result Result message. + * @param author Default Package Authors' names. + * @param description Description of the default package. + * @return True if the operation was successful. + */ + bool CreateProject( + const std::string& name, + const std::string& location, + std::string*& result, + const std::string& author = "unknown", + const std::string& description = "no description" + ); + /** + * Opens an existing project given the source or the binaries folder. + * @param path Path to the project source or binaries folder. + * @param result Result message. + * @return True if the operation was successful. + */ + bool OpenProject( + const std::string& path, + std::string*& result + ); + /** + * Refreshes the currently active project structure. + * @param result Result message. + * @return True if the operation was successful. + */ + bool RefreshProject( + std::string*& result + ); + /** + * Closes the currently active project. This method deletes the project model but doesn't erase the project from the system. + * @param result Result message. + * @return True if the operation was successful. + */ + bool CloseProject( + std::string*& result + ); + private: + /** + * Currently active project reference. + */ modelCDMProject* project; + /** + * Map of all the elements of the currently active project and their IDs. + */ + std::map< wxCDMTreeItemId, modelCDMIProjectTreeNode* > modelElements; };