lib/creaDevManagerLib/modelCDMApplication.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  * modelCDMApplication.h
  30  *
  31  *  Created on: Nov 23, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMAPPLICATION_H_
  36 #define MODELCDMAPPLICATION_H_
  37
  38 #include<iostream>
  39 #include<vector>
  40 #include<map>
  41
  42 #include "modelCDMFolder.h"
  43 #include "modelCDMFile.h"
  44
  45 /**
  46  * Class representing an application in a Crea project. An Application is an stand alone application that uses the project libraries to show their functionalities.
  47  */
  48 class modelCDMApplication : public modelCDMFolder
  49 {
  50 public:
  51   /**
  52    * Default Constructor.
  53    */
  54   modelCDMApplication();
  55   /**
  56    * Application Constructor
  57    * @param parent Parent node of the application node.
  58    * @param path Full path of the application node.
  59    * @param name Name of the applcation folder node.
  60    * @param level Level of the application node folder in the project.
  61    */
  62   modelCDMApplication(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 2);
  63   /**
  64    * Destructor.
  65    */
  66   ~modelCDMApplication();
  67
  68   /**
  69    * Returns the executable name of the application node
  70    * @return
  71    */
  72   const std::string& GetExecutableName() const;
  73   /**
  74    * Returns the main source file of the application node. That is, the file that contains the main method.
  75    * @return File reference to main file.
  76    */
  77   modelCDMFile* GetMainFile() const;
  78
  79   /**
  80    * Sets the executable name for the application.
  81    * @param fileName Name of the application executable.
  82    * @param result Result message.
  83    * @return True if the operation was successful.
  84    */
  85   bool SetExecutableName(const std::string& fileName, std::string*& result);
  86
  87   /**
  88    * Creates a folder in the application folder node. This takes effect in the system as well as in the project model.
  89    * @param name Name of the new folder.
  90    * @param result Result message.
  91    * @return True if the operation was successful.
  92    */
  93   modelCDMFolder* CreateFolder(const std::string& name, std::string*& result);
  94
  95   /**
  96    * Refreshes the structure of the application. Removes folders and files deleted since the last refresh. Also, adds folders and files created since the las refresh.
  97    * @param result Result message.
  98    * @return True if the operation was successful.
  99    */
 100   virtual const bool Refresh(std::string*& result);
 101
 102   /**
 103    * Checks the CMakeLists file and the application structure to identify registration errors before compiling the project.
 104    * @param properties Properties found in the structure.
 105    */
 106   void CheckStructure(std::map<std::string, bool>& properties);
 107
 108   /**
 109    * Checks the application's CMakeLists file to check which third party libraries are enabled.
 110    * @return A map with the name of the library and if it's included in the CMakeLists file.
 111    */
 112   std::map<std::string, bool> Get3rdPartyLibraries();
 113
 114   /**
 115    * Sets the 3rd party library inclusion in the application's CMakeLists file.
 116    * @return if the operation was successful.
 117    */
 118   bool Set3rdPartyLibrary(const std::string& library_name, const bool& toInclude);
 119
 120   /**
 121    * Checks the application's CMakeLists file to check which custom libraries are enabled.
 122    * @return A map with the name of the library and if it's included in the CMakeLists file.
 123    */
 124   std::map<std::string, bool> GetCustomLibraries();
 125
 126   /**
 127    * Sets the custom library inclusion in the application's CMakeLists file.
 128    * @return if the operation was successful.
 129    */
 130   bool SetCustomLibrary(const std::string& library_name, const bool& toInclude);
 131
 132 private:
 133   /**
 134    * Name of the application executable file.
 135    */
 136   std::string executableName;
 137   /**
 138    * Reference to the main file of the application.
 139    */
 140   modelCDMFile* mainFile;
 141   /**
 142    * Reference array of the children folders of the application.
 143    */
 144   std::vector<modelCDMFolder*> folders;
 145 };
 146
 147 #endif /* MODELCDMAPPLICATION_H_ */