lib/creaDevManagerLib/modelCDMLibrary.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  * modelCDMLibrary.h
  30  *
  31  *  Created on: Nov 23, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMLIBRARY_H_
  36 #define MODELCDMLIBRARY_H_
  37
  38 #include<iostream>
  39 #include<vector>
  40 #include<map>
  41
  42 #include "modelCDMFolder.h"
  43
  44 /**
  45  * Class that represents a library in a Crea project.
  46  */
  47 class modelCDMLibrary : public modelCDMFolder
  48 {
  49 public:
  50   /**
  51    * Default Constructor
  52    */
  53   modelCDMLibrary();
  54   /**
  55    * Constructor of the Library node.
  56    * @param parent Parent node of the library node.
  57    * @param path Full path to the library node.
  58    * @param name Name of the library folder node.
  59    * @param level Project hierarchy level of the library folder node.
  60    */
  61   modelCDMLibrary(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 2);
  62   /**
  63    * Destructor.
  64    */
  65   ~modelCDMLibrary();
  66
  67   /**
  68    * Retrieves the name of the Library node. The name of a library can be different than the name of the folder that contains it
  69    * @return Name of the library node.
  70    */
  71   const std::string& GetNameLibrary() const;
  72   /**
  73    * Renames the library with the given name.
  74    * @param fileName New name of the library node.
  75    * @param result Result message.
  76    * @return True if the operation was successful.
  77    */
  78   bool SetNameLibrary(const std::string& fileName, std::string*& result);
  79
  80   /**
  81    * Creates a new folder inside the library folder node. This method not only modifies the project model, but also the system.
  82    * @param name Name of the new folder.
  83    * @param result Result message.
  84    * @return True if the operation was successful.
  85    */
  86   modelCDMFolder* CreateFolder(const std::string& name, std::string*& result);
  87
  88   /**
  89    * Refreshes the structure of the library folder node. Deletes files and folders deleted since last refresh, adds files and folders created since last refresh.
  90    * @param result Result message.
  91    * @return True if the operation was successful.
  92    */
  93   virtual const bool Refresh(std::string*& result);
  94
  95   /**
  96    * Checks the library structure and CMakeLists file to find project structure definition problems before compiling the project.
  97    * @param properties Project properties.
  98    */
  99   void CheckStructure(std::map<std::string, bool>& properties);
 100
 101   /**
 102    * Checks the library CMakeLists file to check which third party libraries are enabled.
 103    * @return A map with the name of the library and if it's included in the CMakeLists file.
 104    */
 105   std::map<std::string, bool> Get3rdPartyLibraries();
 106
 107   /**
 108    * Sets the 3rd party library inclusion in the CMakeLists file.
 109    * @return if the operation was successful.
 110    */
 111   bool Set3rdPartyLibrary(const std::string& library_name, const bool& toInclude);
 112
 113   /**
 114    * Checks the library CMakeLists file to check which custom libraries are enabled.
 115    * @return A map with the name of the library and if it's included in the CMakeLists file.
 116    */
 117   std::map<std::string, bool> GetCustomLibraries();
 118
 119   /**
 120    * Sets the custom library inclusion in the CMakeLists file.
 121    * @return if the operation was successful.
 122    */
 123   bool SetCustomLibrary(const std::string& library_name, const bool& toInclude);
 124
 125 private:
 126   /**
 127    * Name of the library node. The name of a library can be different than the library folder name.
 128    */
 129   std::string nameLibrary;
 130   /**
 131    * Folder reference array of folder node inside the library node.
 132    */
 133   std::vector<modelCDMFolder*> folders;
 134 };
 135
 136 #endif /* MODELCDMLIBRARY_H_ */