lib/creaDevManagerLib/modelCDMBBGFile.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  * modelCDMBBGFile.h
  30  *
  31  *  Created on: Jun 27, 2013
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMBBGFILE_H_
  36 #define MODELCDMBBGFILE_H_
  37
  38 #include "modelCDMFile.h"
  39
  40 /**
  41  * Class representing a bbg file in a folder of a Crea project.
  42  */
  43 class modelCDMBBGFile : public modelCDMFile
  44 {
  45 public:
  46   /**
  47    * Default Constructor.
  48    */
  49   modelCDMBBGFile();
  50   /**
  51    * BBG file Constructor.
  52    * @param parent Parent node of the BBG file node.
  53    * @param path Full path to the BBG file node.
  54    * @param name File name of the BBG file node.
  55    * @param level Project hierarchy level of the BBG file node.
  56    */
  57   modelCDMBBGFile(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name = "CMakeLists.txt", const int& level = 1);
  58   /**
  59    * Destructor
  60    */
  61   ~modelCDMBBGFile();
  62
  63   /**
  64    * Opens the file in the system default code editor.
  65    * @param result Result message.
  66    * @return True if the operation was successful.
  67    */
  68   bool OpenFile(std::string*& result);
  69
  70   /**
  71    * Opens the file using bbEditor.
  72    * @param parameters Execution parameters.
  73    * @param result Result message.
  74    * @return True if the operation was successful.
  75    */
  76   bool EditFile(std::string*& result, const std::string& parameters = "");
  77
  78   /**
  79    * Refreshes the state of the BBG file.
  80    * @param result Result message.
  81    * @return True if the operation was successful.
  82    */
  83   virtual const bool Refresh(std::string*& result);
  84 };
  85
  86 #endif /* MODELCDMBBGFILE_H_ */