lib/kernel_ManagerContour_NDimensions/ExecutableCommand.h

   1 /*# ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Sant�)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26 #ifndef __EXECUTABLE_COMMAND__
  27 #define __EXECUTABLE_COMMAND__
  28
  29
  30
  31 //------------------------------------------------------------------------------------------------------------
  32 // Includes
  33 //------------------------------------------------------------------------------------------------------------
  34 #include <iostream>
  35 #include "CommandObject.h"
  36
  37 class ExecutableCommand : public CommandObject{
  38
  39 //------------------------------------------------------------------------------------------------------------
  40 // Constructors & Destructors
  41 //------------------------------------------------------------------------------------------------------------
  42 public:
  43
  44         /*
  45         * Creates a command (executable) with the given text
  46         * @param aText Is the text to assign to the command
  47         * @return Returns the created ExecutableCommand pointer
  48         */
  49         ExecutableCommand(std::string aText );
  50
  51         /*
  52         * Destroys the command
  53         */
  54         virtual ~ExecutableCommand( );
  55 //------------------------------------------------------------------------------------------------------------
  56 // Methods
  57 //------------------------------------------------------------------------------------------------------------
  58
  59
  60         /*
  61         * Gets the text of the command
  62         * @return text Is the text of the command
  63         */
  64         std::string getText();
  65
  66         /*
  67         * Sets the text of the command
  68         * @param theText Is the text of the command
  69         */
  70         void setText(std::string theText);
  71
  72         /*
  73         * Includes the command into the given queue for execution
  74         * @param executionQueue Is the queue in which is included the command
  75         */
  76         virtual void includeToExecute(std::deque<CommandObject * > & executionQueue);
  77
  78         /*
  79         * Counts the command(s)
  80         * @return The value of commands that represents this
  81         */
  82         virtual int count();
  83
  84         /*
  85         * Method that clears the command
  86         */
  87         virtual void clear();
  88
  89 //------------------------------------------------------------------------------------------------------------
  90 // Constants
  91 //------------------------------------------------------------------------------------------------------------
  92
  93 private:
  94 //------------------------------------------------------------------------------------------------------------
  95 // Attributes
  96 //------------------------------------------------------------------------------------------------------------
  97
  98         /*
  99         * Represents the text of the command
 100         */
 101         std::string text;
 102
 103 };
 104 #endif