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
  44 /**
  45  * Class representing a folder in the project hierarchy.
  46  */
  47 class modelCDMFolder : public modelCDMIProjectTreeNode
  48 {
  49 public:
  50   /**
  51    * Default constructor.
  52    */
  53   modelCDMFolder();
  54   /**
  55    * Constructor of the folder node.
  56    * @param parent Parent node.
  57    * @param path Full path of the folder node.
  58    * @param name Folder name of the folder node.
  59    * @param level Hierarchy level of the folder node in the project.
  60    */
  61   modelCDMFolder(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3);
  62   /**
  63    * Destructor.
  64    */
  65   ~modelCDMFolder();
  66
  67   /**
  68    * Returns the reference to the folder node's CMakeLists file if it exists.
  69    * @return Reference to the CMakeLists file or NULL.
  70    */
  71   modelCDMCMakeListsFile* GetCMakeLists() const;
  72   /**
  73    * Returns an array with the containing folder children of the actual folder node.
  74    * @return Array with references to children folder nodes.
  75    */
  76   std::vector<modelCDMFolder*> GetFolders() const;
  77
  78   /**
  79    * Creates a class (.h and .cpp files) in the folder node. It creates the files in the model as well as in the system.
  80    * @param name Name of the class to create.
  81    * @return True if the operation was successful.
  82    */
  83   bool CreateClass(const std::string& name);
  84
  85   /**
  86    * Creates a folder in the folder node. It creates the folder in the model as well as in the system.
  87    * @param name Name of the folder to create.
  88    * @param result Result message of the operation.
  89    * @return True if the operation was successful.
  90    */
  91   modelCDMFolder* CreateFolder(
  92       const std::string& name,
  93       std::string*& result
  94   );
  95   /**
  96    * Opens the CMakeLists file in the default code editor.
  97    * @param result Result message of the operation.
  98    * @return True if the operation was successful.
  99    */
 100   bool OpenCMakeListsFile(std::string* & result);
 101   /**
 102    * Refreshes the folder node structure. deletes deleted files and folders, and adds created files and folders.
 103    * @param result Result message of the operation
 104    * @return True if the operation was successful.
 105    */
 106   virtual const bool Refresh(std::string*& result);
 107
 108   /**
 109    * Returns wether the CMakeLists attribute is different from NULL or not.
 110    * @return True if the MakeLists attribute is different from NULL.
 111    */
 112   bool HasCMakeLists();
 113
 114 protected:
 115   /**
 116    * Reference to the folder node's CMakeLists.
 117    */
 118   modelCDMCMakeListsFile* CMakeLists;
 119 private:
 120   /**
 121    * Reference array to the children folders.
 122    */
 123   std::vector<modelCDMFolder*> folders;
 124
 125 };
 126
 127 #endif /* MODELCDMFOLDER_H_ */