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 # ------------------------------------------------------------------------
31 * Created on: Nov 23, 2012
32 * Author: Daniel Felipe Gonzalez Obando
35 #ifndef MODELCDMLIBRARY_H_
36 #define MODELCDMLIBRARY_H_
42 #include "modelCDMFolder.h"
45 * Class that represents a library in a Crea project.
47 class modelCDMLibrary : public modelCDMFolder
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.
61 modelCDMLibrary(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 2);
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.
71 const std::string& GetNameLibrary() const;
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.
78 bool SetNameLibrary(const std::string& fileName, std::string*& result);
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.
86 modelCDMFolder* CreateFolder(const std::string& name, std::string*& result);
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.
93 virtual const bool Refresh(std::string*& result);
96 * Checks the library structure and CMakeLists file to find project structure definition problems before compiling the project.
97 * @param properties Project properties.
99 void CheckStructure(std::map<std::string, bool>& properties);
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.
105 std::map<std::string, bool> Get3rdPartyLibraries();
108 * Sets the 3rd party library inclusion in the CMakeLists file.
109 * @return if the operation was successful.
111 bool Set3rdPartyLibrary(const std::string& library_name, const bool& toInclude);
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.
117 std::map<std::string, bool> GetCustomLibraries();
120 * Sets the custom library inclusion in the CMakeLists file.
121 * @return if the operation was successful.
123 bool SetCustomLibrary(const std::string& library_name, const bool& toInclude);
127 * Name of the library node. The name of a library can be different than the library folder name.
129 std::string nameLibrary;
131 * Folder reference array of folder node inside the library node.
133 std::vector<modelCDMFolder*> folders;
136 #endif /* MODELCDMLIBRARY_H_ */