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 28, 2012
32 * Author: Daniel Felipe Gonzalez Obando
35 #ifndef MODELCDMFOLDER_H_
36 #define MODELCDMFOLDER_H_
41 #include "modelCDMIProjectTreeNode.h"
42 #include "modelCDMCMakeListsFile.h"
43 #include "modelCDMCodeFile.h"
44 #include "modelCDMBBSFile.h"
47 * Class representing a folder in the project hierarchy.
49 class modelCDMFolder : public modelCDMIProjectTreeNode
53 * Default constructor.
57 * Constructor of the folder node.
58 * @param parent Parent node.
59 * @param path Full path of the folder node.
60 * @param name Folder name of the folder node.
61 * @param level Hierarchy level of the folder node in the project.
63 modelCDMFolder(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3);
70 * Returns the reference to the folder node's CMakeLists file if it exists.
71 * @return Reference to the CMakeLists file or NULL.
73 modelCDMCMakeListsFile* GetCMakeLists() const;
75 * Returns an array with the containing folder children of the actual folder node.
76 * @return Array with references to children folder nodes.
78 std::vector<modelCDMFolder*> GetFolders() const;
81 * Creates a class (.h and .cpp files) in the folder node. It creates the files in the model as well as in the system.
82 * @param name Name of the class to create.
83 * @return True if the operation was successful.
85 bool CreateClass(const std::string& name);
88 * Creates a folder in the folder node. It creates the folder in the model as well as in the system.
89 * @param name Name of the folder to create.
90 * @param result Result message of the operation.
91 * @return True if the operation was successful.
93 modelCDMFolder* CreateFolder(
94 const std::string& name,
98 * Opens the CMakeLists file in the default code editor.
99 * @param result Result message of the operation.
100 * @return True if the operation was successful.
102 bool OpenCMakeListsFile(std::string* & result);
104 * Refreshes the folder node structure. deletes deleted files and folders, and adds created files and folders.
105 * @param result Result message of the operation
106 * @return True if the operation was successful.
108 virtual const bool Refresh(std::string*& result);
111 * Returns wether the CMakeLists attribute is different from NULL or not.
112 * @return True if the MakeLists attribute is different from NULL.
114 bool HasCMakeLists();
118 * Reference to the folder node's CMakeLists.
120 modelCDMCMakeListsFile* CMakeLists;
123 * Reference array to the children folders.
125 std::vector<modelCDMFolder*> folders;
129 #endif /* MODELCDMFOLDER_H_ */