lib/kernel_ManagerContour_NDimensions/CommandObject.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 __COMMAND_OBJECT__
  27 #define __COMMAND_OBJECT__
  28
  29
  30
  31 //------------------------------------------------------------------------------------------------------------
  32 // Includes
  33 //------------------------------------------------------------------------------------------------------------
  34
  35 #include <iostream>
  36 #include <deque>
  37
  38 class CommandObject{
  39
  40 //------------------------------------------------------------------------------------------------------------
  41 // Constructors & Destructors
  42 //------------------------------------------------------------------------------------------------------------
  43 public:
  44
  45         /*
  46         * Creates a command with the given text
  47         * @return Returns the created commandObject pointer
  48         */
  49         CommandObject( );
  50
  51         /*
  52         * Destroys the command
  53         */
  54         virtual ~CommandObject( );
  55 //------------------------------------------------------------------------------------------------------------
  56 // Methods
  57 //------------------------------------------------------------------------------------------------------------
  58
  59         /*
  60         * Includes the command into the given queue for execution
  61         * @param executionQueue Is the queue in which is included the command
  62         */
  63         virtual void includeToExecute(std::deque<CommandObject *> &executionQueue)=0;
  64
  65         /*
  66         * Counts the command(s)
  67         * @return The value of commands that represents this
  68         */
  69         virtual int count() = 0;
  70
  71         /*
  72         * Method that clears the command
  73         */
  74         virtual void clear() = 0;
  75
  76 //------------------------------------------------------------------------------------------------------------
  77 // Constants
  78 //------------------------------------------------------------------------------------------------------------
  79
  80 private:
  81 //------------------------------------------------------------------------------------------------------------
  82 // Attributes
  83 //------------------------------------------------------------------------------------------------------------
  84
  85         int accum;
  86
  87 };
  88 #endif