lib/creaDevManagerLib/modelCDMFolder.h

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Sant�)
   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
   9 #
  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.
  16 #
  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
  21 #  liability.
  22 #
  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 # ------------------------------------------------------------------------
  26  */
  27
  28 /*
  29  * modelCDMFolder.h
  30  *
  31  *  Created on: Nov 28, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMFOLDER_H_
  36 #define MODELCDMFOLDER_H_
  37
  38 #include<iostream>
  39 #include<vector>
  40
  41 #include "modelCDMIProjectTreeNode.h"
  42 #include "modelCDMCMakeListsFile.h"
  43 #include "modelCDMCodeFile.h"
  44
  45 /**
  46  * Class representing a folder in the project hierarchy.
  47  */
  48 class modelCDMFolder : public modelCDMIProjectTreeNode
  49 {
  50 public:
  51   /**
  52    * Default constructor.
  53    */
  54   modelCDMFolder();
  55   /**
  56    * Constructor of the folder node.
  57    * @param parent Parent node.
  58    * @param path Full path of the folder node.
  59    * @param name Folder name of the folder node.
  60    * @param level Hierarchy level of the folder node in the project.
  61    */
  62   modelCDMFolder(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3);
  63   /**
  64    * Destructor.
  65    */
  66   ~modelCDMFolder();
  67
  68   /**
  69    * Returns the reference to the folder node's CMakeLists file if it exists.
  70    * @return Reference to the CMakeLists file or NULL.
  71    */
  72   modelCDMCMakeListsFile* GetCMakeLists() const;
  73   /**
  74    * Returns an array with the containing folder children of the actual folder node.
  75    * @return Array with references to children folder nodes.
  76    */
  77   std::vector<modelCDMFolder*> GetFolders() const;
  78
  79   /**
  80    * Creates a class (.h and .cpp files) in the folder node. It creates the files in the model as well as in the system.
  81    * @param name Name of the class to create.
  82    * @return True if the operation was successful.
  83    */
  84   bool CreateClass(const std::string& name);
  85
  86   /**
  87    * Creates a folder in the folder node. It creates the folder in the model as well as in the system.
  88    * @param name Name of the folder to create.
  89    * @param result Result message of the operation.
  90    * @return True if the operation was successful.
  91    */
  92   modelCDMFolder* CreateFolder(
  93       const std::string& name,
  94       std::string*& result
  95   );
  96   /**
  97    * Opens the CMakeLists file in the default code editor.
  98    * @param result Result message of the operation.
  99    * @return True if the operation was successful.
 100    */
 101   bool OpenCMakeListsFile(std::string* & result);
 102   /**
 103    * Refreshes the folder node structure. deletes deleted files and folders, and adds created files and folders.
 104    * @param result Result message of the operation
 105    * @return True if the operation was successful.
 106    */
 107   virtual const bool Refresh(std::string*& result);
 108
 109   /**
 110    * Returns wether the CMakeLists attribute is different from NULL or not.
 111    * @return True if the MakeLists attribute is different from NULL.
 112    */
 113   bool HasCMakeLists();
 114
 115 protected:
 116   /**
 117    * Reference to the folder node's CMakeLists.
 118    */
 119   modelCDMCMakeListsFile* CMakeLists;
 120 private:
 121   /**
 122    * Reference array to the children folders.
 123    */
 124   std::vector<modelCDMFolder*> folders;
 125
 126 };
 127
 128 #endif /* MODELCDMFOLDER_H_ */