creaContours_lib
ICommandsUser.h
Go to the documentation of this file.
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 __ICOMMANDS_USER__
27 #define __ICOMMANDS_USER__
28 
29 
30 //------------------------------------------------------------------------------------------------------------
31 // Includes
32 //------------------------------------------------------------------------------------------------------------
33 
34 #include <iostream>
35 #include <deque>
36 #include "CommandObject.h"
37 
38 class ICommandsUser{
39 
40 //------------------------------------------------------------------------------------------------------------
41 // Constructors & Destructors
42 //------------------------------------------------------------------------------------------------------------
43 public:
44  virtual ~ICommandsUser() {};
45 
46 
47 //------------------------------------------------------------------------------------------------------------
48 // Methods
49 //------------------------------------------------------------------------------------------------------------
50 
51 
52  /*
53  * Executes a command by resending the received parameters to its parent to do the appropiate interpretation and execution.
54  * @param theCommand Is the command to execute
55  * @param fromRegistration Indicates if the execution is directed from the registration, by default comes from the GUI = false.
56  */
57  virtual bool executeCommand(CommandObject * theCommand, bool fromRegistration=false) = 0;
58 
59  /*
60  * Executes a command queue by resending the received parameters to its parent to do the appropiate interpretation and execution.
61  * @param executionQueue Is the command queue to execute
62  * @param fromRegistration Indicates if the execution is directed from the registration, by default comes from the GUI = false.
63  */
64  virtual bool executeCommandsQueue(std::deque<CommandObject *> & executionQueue, bool fromRegistration) = 0;
65 
66 
67 };
68 #endif
69