packages/std/src/bbstdExecSystemCommand.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   Program:   bbtk
  30   Module:    $RCSfile: bbstdExecSystemCommand.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:51:32 $
  33   Version:   $Revision: 1.9 $
  34 =========================================================================*/
  35
  36 #ifndef __bbstdExecSystemCommand_h_INCLUDED__
  37 #define __bbstdExecSystemCommand_h_INCLUDED__
  38
  39 #include "bbtkAtomicBlackBox.h"
  40 #include "bbstd_EXPORT.h"
  41
  42 namespace bbstd
  43 {
  44
  45   class bbstd_EXPORT ExecSystemCommand
  46     :
  47   public bbtk::AtomicBlackBox
  48   {
  49   public:
  50     BBTK_BLACK_BOX_INTERFACE(ExecSystemCommand,bbtk::AtomicBlackBox);
  51     BBTK_DECLARE_INPUT(In,std::string)
  52     BBTK_DECLARE_INPUT(Verbose,bool)
  53     BBTK_DECLARE_OUTPUT(Return,int);
  54     BBTK_PROCESS(DoProcess);
  55     void DoProcess();
  56   };
  57
  58   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ExecSystemCommand,bbtk::AtomicBlackBox);
  59    BBTK_NAME("ExecSystemCommand");
  60    BBTK_AUTHOR("eduardo.davila@creatis.insa-lyon.fr");
  61    BBTK_DESCRIPTION("Executes system (O.S.) commands");
  62    BBTK_INPUT(ExecSystemCommand,In,"system (O.S.) commands separated by ';' , use '' to indicate strings ex. help 'graph' ",std::string,"");
  63    BBTK_INPUT(ExecSystemCommand,Verbose,"(true default) true with console message / false NO console message",bool,"");
  64    BBTK_OUTPUT(ExecSystemCommand,Return,"result (0 if no error or error number of the first error",int,"");
  65   BBTK_END_DESCRIBE_BLACK_BOX(ExecSystemCommand);
  66
  67 } // EO namespace bbstd
  68
  69 #endif //  __bbstdExecSystemCommand_h_INCLUDED__
  70
  71