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"
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.
48 class modelCDMApplication : public modelCDMFolder
52 * Default Constructor.
54 modelCDMApplication();
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.
62 modelCDMApplication(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 2);
66 ~modelCDMApplication();
69 * Returns the executable name of the application node
72 const std::string& GetExecutableName() const;
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.
77 modelCDMFile* GetMainFile() const;
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.
85 bool SetExecutableName(const std::string& fileName, std::string*& result);
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.
93 modelCDMFolder* CreateFolder(const std::string& name, std::string*& result);
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.
100 virtual const bool Refresh(std::string*& result);
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.
106 void CheckStructure(std::map<std::string, bool>& properties);
110 * Name of the application executable file.
112 std::string executableName;
114 * Reference to the main file of the application.
116 modelCDMFile* mainFile;
118 * Reference array of the children folders of the application.
120 std::vector<modelCDMFolder*> folders;
123 #endif /* MODELCDMAPPLICATION_H_ */