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"
45 #include "modelCDMBBGFile.h"
48 * Class representing a folder in the project hierarchy.
50 class modelCDMFolder : public modelCDMIProjectTreeNode
54 * Default constructor.
58 * Constructor of the folder node.
59 * @param parent Parent node.
60 * @param path Full path of the folder node.
61 * @param name Folder name of the folder node.
62 * @param level Hierarchy level of the folder node in the project.
64 modelCDMFolder(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3);
71 * Returns the reference to the folder node's CMakeLists file if it exists.
72 * @return Reference to the CMakeLists file or NULL.
74 modelCDMCMakeListsFile* GetCMakeLists() const;
76 * Returns an array with the containing folder children of the actual folder node.
77 * @return Array with references to children folder nodes.
79 std::vector<modelCDMFolder*> GetFolders() const;
82 * Creates a class (.h and .cpp files) in the folder node. It creates the files in the model as well as in the system.
83 * @param name Name of the class to create.
84 * @return True if the operation was successful.
86 bool CreateClass(const std::string& name);
89 * Creates a folder in the folder node. It creates the folder in the model as well as in the system.
90 * @param name Name of the folder to create.
91 * @param result Result message of the operation.
92 * @return True if the operation was successful.
94 modelCDMFolder* CreateFolder(
95 const std::string& name,
99 * Opens the CMakeLists file in the default code editor.
100 * @param result Result message of the operation.
101 * @return True if the operation was successful.
103 bool OpenCMakeListsFile(std::string* & result);
105 * Refreshes the folder node structure. deletes deleted files and folders, and adds created files and folders.
106 * @param result Result message of the operation
107 * @return True if the operation was successful.
109 virtual const bool Refresh(std::string*& result);
112 * Returns wether the CMakeLists attribute is different from NULL or not.
113 * @return True if the MakeLists attribute is different from NULL.
115 bool HasCMakeLists();
119 * Reference to the folder node's CMakeLists.
121 modelCDMCMakeListsFile* CMakeLists;
124 * Reference array to the children folders.
126 std::vector<modelCDMFolder*> folders;
130 #endif /* MODELCDMFOLDER_H_ */