2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
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
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.
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
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 # ------------------------------------------------------------------------
29 * modelCDMApplication.h
31 * Created on: Nov 23, 2012
32 * Author: Daniel Felipe Gonzalez Obando
35 #ifndef MODELCDMAPPLICATION_H_
36 #define MODELCDMAPPLICATION_H_
42 #include "modelCDMFolder.h"
43 #include "modelCDMFile.h"
44 #include "modelCDMCodeFile.h"
47 * Class representing an application in a Crea project. An Application is an stand alone application that uses the project libraries to show their functionalities.
49 class modelCDMApplication : public modelCDMFolder
53 * Default Constructor.
55 modelCDMApplication();
57 * Application Constructor
58 * @param parent Parent node of the application node.
59 * @param path Full path of the application node.
60 * @param name Name of the applcation folder node.
61 * @param level Level of the application node folder in the project.
63 modelCDMApplication(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 2);
67 ~modelCDMApplication();
70 * Returns the executable name of the application node
73 const std::string& GetExecutableName() const;
75 * Returns the main source file of the application node. That is, the file that contains the main method.
76 * @return File reference to main file.
78 modelCDMFile* GetMainFile() const;
81 * Sets the executable name for the application.
82 * @param fileName Name of the application executable.
83 * @param result Result message.
84 * @return True if the operation was successful.
86 bool SetExecutableName(const std::string& fileName, std::string*& result);
89 * Creates a folder in the application folder node. This takes effect in the system as well as in the project model.
90 * @param name Name of the new folder.
91 * @param result Result message.
92 * @return True if the operation was successful.
94 modelCDMFolder* CreateFolder(const std::string& name, std::string*& result);
97 * 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.
98 * @param result Result message.
99 * @return True if the operation was successful.
101 virtual const bool Refresh(std::string*& result);
104 * Checks the CMakeLists file and the application structure to identify registration errors before compiling the project.
105 * @param properties Properties found in the structure.
107 void CheckStructure(std::map<std::string, bool>& properties);
110 * Checks the application's CMakeLists file to check which third party libraries are enabled.
111 * @return A map with the name of the library and if it's included in the CMakeLists file.
113 std::map<std::string, bool> Get3rdPartyLibraries();
116 * Sets the 3rd party library inclusion in the application's CMakeLists file.
117 * @return if the operation was successful.
119 bool Set3rdPartyLibrary(const std::string& library_name, const bool& toInclude);
122 * Checks the application's CMakeLists file to check which custom libraries are enabled.
123 * @return A map with the name of the library and if it's included in the CMakeLists file.
125 std::map<std::string, bool> GetCustomLibraries();
128 * Sets the custom library inclusion in the application's CMakeLists file.
129 * @return if the operation was successful.
131 bool SetCustomLibrary(const std::string& library_name, const bool& toInclude);
135 * Name of the application executable file.
137 std::string executableName;
139 * Reference to the main file of the application.
141 modelCDMFile* mainFile;
143 * Reference array of the children folders of the application.
145 std::vector<modelCDMFolder*> folders;
148 #endif /* MODELCDMAPPLICATION_H_ */