lib/creaDevManagerLib/modelCDMFile.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  * modelCDMFile.h
  30  *
  31  *  Created on: Nov 28, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef MODELCDMFILE_H_
  36 #define MODELCDMFILE_H_
  37
  38 #include<iostream>
  39 #include<vector>
  40
  41 #include "modelCDMIProjectTreeNode.h"
  42
  43 /**
  44  * Class representing a file node in the project hierarchy.
  45  */
  46 class modelCDMFile : public modelCDMIProjectTreeNode
  47 {
  48 public:
  49   /**
  50    * Default constructor
  51    */
  52   modelCDMFile();
  53   /**
  54    * Constructor of the File node class
  55    * @param parent Parent node of the file node.
  56    * @param path Full path to the file node
  57    * @param name File name of the file node.
  58    * @param level Hierarchy level of the file node. By default 3.
  59    */
  60   modelCDMFile(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3);
  61   /**
  62    * Destructor
  63    */
  64   ~modelCDMFile();
  65
  66   /**
  67    * Opens the file node with the provided command.
  68    * @param result Result message of the operation.
  69    * @param command Command to open the file.
  70    * @return True if the operation was successful.
  71    */
  72   bool OpenFile(std::string* & result, const std::string& command = "");
  73   /**
  74    * Refreshes the file properties and checks that the file exists.
  75    * @param result Result message of the operation.
  76    * @return True if the operation was successful.
  77    */
  78   virtual const bool Refresh(std::string*& result);
  79   /**
  80    * Opens the file node in the default file explorer.
  81    * @param result Result message of the operation.
  82    * @return True if the operation was successful.
  83    */
  84   const bool OpenInFileExplorer(std::string*& result) const;
  85 };
  86
  87 #endif /* MODELCDMFILE_H_ */