packages/std/src/bbstdGetVectorElement.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: bbstdGetVectorElement.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:51:32 $
  33   Version:   $Revision: 1.9 $
  34 =========================================================================*/
  35
  36
  37 #ifndef __bbstdGetVectorElement_INCLUDED_h__
  38 #define __bbstdGetVectorElement_INCLUDED_h__
  39
  40 #include "bbtkAtomicBlackBox.h"
  41 #include "bbstd_EXPORT.h"
  42
  43 namespace bbstd
  44 {
  45   //=================================================================
  46   // BlackBox declaration
  47   template <class T>
  48   class bbstd_EXPORT GetVectorElement : public bbtk::AtomicBlackBox
  49   {
  50     BBTK_TEMPLATE_BLACK_BOX_INTERFACE(GetVectorElement,bbtk::AtomicBlackBox,T);
  51     BBTK_DECLARE_INPUT(In,std::vector<T>);
  52     BBTK_DECLARE_INPUT(I,int);
  53         BBTK_DECLARE_INPUT(ErrorValue,T);
  54     BBTK_DECLARE_OUTPUT(Out,T);
  55     BBTK_PROCESS(DoIt);
  56     void DoIt();
  57   };
  58   //=================================================================
  59
  60   //=================================================================
  61   // BlackBox description
  62   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(GetVectorElement,bbtk::AtomicBlackBox);
  63   BBTK_NAME("Get"+bbtk::HumanTypeName<std::vector<T> >()+"Element");
  64   BBTK_AUTHOR("info-dev@creatis.insa-lyon.fr");
  65  // BBTK_DEFAULT_ADAPTOR();
  66   BBTK_DESCRIPTION("Gets the i-th element from the input vector ("+bbtk::TypeName<std::vector<T> >());
  67   typedef std::vector<T> Tvector;
  68   BBTK_TEMPLATE_INPUT(GetVectorElement, In,"Input",Tvector);
  69   BBTK_TEMPLATE_INPUT(GetVectorElement, I, "iElement (default 0)",int);
  70   BBTK_TEMPLATE_INPUT(GetVectorElement, ErrorValue, "ErrorValue",T);
  71   BBTK_TEMPLATE_OUTPUT(GetVectorElement,Out,"Output",T);
  72   BBTK_END_DESCRIBE_TEMPLATE_BLACK_BOX(GetVectorElement);
  73   //=================================================================
  74
  75   //=================================================================
  76   template <class T>
  77   void GetVectorElement<T>::DoIt()
  78   {
  79           if (( bbGetInputI() < (int)bbGetInputIn().size() )  &&  ( bbGetInputI() >= 0 ) )
  80           {
  81                   bbSetOutputOut( bbGetInputIn()[bbGetInputI()] );
  82           } else {
  83                   bbSetOutputOut( bbGetInputErrorValue() );
  84           }
  85   }
  86   //=================================================================
  87
  88   //=================================================================
  89   template <class T>
  90   void GetVectorElement<T>::bbUserSetDefaultValues()
  91   {
  92         bbSetInputI(0);
  93   }
  94   //=================================================================
  95   //=================================================================
  96   template <class T>
  97   void GetVectorElement<T>::bbUserInitializeProcessing()
  98   {
  99
 100   }
 101   //=================================================================
 102   //=================================================================
 103   template <class T>
 104   void GetVectorElement<T>::bbUserFinalizeProcessing()
 105   {
 106
 107   }
 108   //=================================================================
 109
 110 } // namespace bbstd
 111
 112 #endif //__bbstdGetVectorElement_INCLUDED_h__
 113