lib/creaDevManagerLib/modelCDMMain.h

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Sant�)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9 #
  10 #  This software is governed by the CeCILL-B license under French law and
  11 #  abiding by the rules of distribution of free software. You can  use,
  12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13 #  license as circulated by CEA, CNRS and INRIA at the following URL
  14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15 #  or in the file LICENSE.txt.
  16 #
  17 #  As a counterpart to the access to the source code and  rights to copy,
  18 #  modify and redistribute granted by the license, users are provided only
  19 #  with a limited warranty  and the software's author,  the holder of the
  20 #  economic rights,  and the successive licensors  have only  limited
  21 #  liability.
  22 #
  23 #  The fact that you are presently reading this means that you have had
  24 #  knowledge of the CeCILL-B license and that you accept its terms.
  25 # ------------------------------------------------------------------------
  26  */
  27
  28 /*
  29  * modelCDMMain.h
  30  *
  31  *  Created on: 13/11/2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMMAIN_H_
  36 #define MODELCDMMAIN_H_
  37
  38 #include<iostream>
  39 #include<map>
  40
  41 #include<creaWx.h>
  42 #include<wx/treectrl.h>
  43
  44 #include "modelCDMIProjectTreeNode.h"
  45 #include "modelCDMProject.h"
  46
  47 /**
  48  * Class representing the model of the project manager.
  49  */
  50 class modelCDMMain
  51 {
  52 public:
  53   /**
  54    * Default constructor.
  55    */
  56   modelCDMMain();
  57   /**
  58    * Destructor.
  59    */
  60   ~modelCDMMain();
  61
  62   /**
  63    * Retrieves the current active project.
  64    * @return Reference to the current active project, if there's no active project NULL is returned.
  65    */
  66   modelCDMProject* GetProject() const;
  67   /**
  68    * Retrieves the map of all the nodes inside the current active project.
  69    * @return Map with ids and node reference of the project.
  70    */
  71   std::map< wxCDMTreeItemId, modelCDMIProjectTreeNode* >& GetModelElements();
  72
  73
  74   /**
  75    * 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.
  76    * @param name Name of the new project.
  77    * @param location Path where the project is to be created.
  78    * @param result Result message.
  79    * @param author Default Package Authors' names.
  80    * @param description Description of the default package.
  81    * @return True if the operation was successful.
  82    */
  83   bool CreateProject(
  84       const std::string& name,
  85       const std::string& location,
  86       std::string*& result,
  87       const std::string& author = "unknown",
  88       const std::string& description = "no description"
  89   );
  90   /**
  91    * Opens an existing project given the source or the binaries folder.
  92    * @param path Path to the project source or binaries folder.
  93    * @param result Result message.
  94    * @return True if the operation was successful.
  95    */
  96   bool OpenProject(
  97       const std::string& path,
  98       std::string*& result
  99   );
 100   /**
 101    * Refreshes the currently active project structure.
 102    * @param result Result message.
 103    * @return True if the operation was successful.
 104    */
 105   bool RefreshProject(
 106       std::string*& result
 107   );
 108   /**
 109    * Closes the currently active project. This method deletes the project model but doesn't erase the project from the system.
 110    * @param result Result message.
 111    * @return True if the operation was successful.
 112    */
 113   bool CloseProject(
 114       std::string*& result
 115   );
 116
 117
 118 private:
 119   /**
 120    * Currently active project reference.
 121    */
 122   modelCDMProject* project;
 123   /**
 124    * Map of all the elements of the currently active project and their IDs.
 125    */
 126   std::map< wxCDMTreeItemId, modelCDMIProjectTreeNode* > modelElements;
 127 };
 128
 129
 130 #endif /* MODELCDMMAIN_H_ */