packages/std/src/bbstdGetVectorElement.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbstdGetVectorElement.h,v $
   4   Language:  C++
   5   Date:      $Date: 2011/07/22 17:42:51 $
   6   Version:   $Revision: 1.8 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31
  32 #ifndef __bbstdGetVectorElement_INCLUDED_h__
  33 #define __bbstdGetVectorElement_INCLUDED_h__
  34
  35 #include "bbtkAtomicBlackBox.h"
  36 #include "bbstd_EXPORT.h"
  37
  38 namespace bbstd
  39 {
  40   //=================================================================
  41   // BlackBox declaration
  42   template <class T>
  43   class bbstd_EXPORT GetVectorElement : public bbtk::AtomicBlackBox
  44   {
  45     BBTK_TEMPLATE_BLACK_BOX_INTERFACE(GetVectorElement,bbtk::AtomicBlackBox,T);
  46     BBTK_DECLARE_INPUT(In,std::vector<T>);
  47     BBTK_DECLARE_INPUT(I,int);
  48         BBTK_DECLARE_INPUT(ErrorValue,T);
  49     BBTK_DECLARE_OUTPUT(Out,T);
  50     BBTK_PROCESS(DoIt);
  51     void DoIt();
  52   };
  53   //=================================================================
  54
  55   //=================================================================
  56   // BlackBox description
  57   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(GetVectorElement,bbtk::AtomicBlackBox);
  58   BBTK_NAME("Get"+bbtk::HumanTypeName<std::vector<T> >()+"Element");
  59   BBTK_AUTHOR("info-dev@creatis.insa-lyon.fr");
  60  // BBTK_DEFAULT_ADAPTOR();
  61   BBTK_DESCRIPTION("Gets the i-th element from the input vector ("+bbtk::TypeName<std::vector<T> >());
  62   typedef std::vector<T> Tvector;
  63   BBTK_TEMPLATE_INPUT(GetVectorElement, In,"Input",Tvector);
  64   BBTK_TEMPLATE_INPUT(GetVectorElement, I, "Input",int);
  65   BBTK_TEMPLATE_INPUT(GetVectorElement, ErrorValue, "ErrorValue",T);
  66   BBTK_TEMPLATE_OUTPUT(GetVectorElement,Out,"Output",T);
  67   BBTK_END_DESCRIBE_TEMPLATE_BLACK_BOX(GetVectorElement);
  68   //=================================================================
  69
  70   //=================================================================
  71   template <class T>
  72   void GetVectorElement<T>::DoIt()
  73   {
  74           if (( bbGetInputI() < bbGetInputIn().size() )  &&  ( bbGetInputI() >= 0 ) )
  75           {
  76                   bbSetOutputOut( bbGetInputIn()[bbGetInputI()] );
  77           } else {
  78                   bbSetOutputOut( bbGetInputErrorValue() );
  79           }
  80   }
  81   //=================================================================
  82
  83   //=================================================================
  84   template <class T>
  85   void GetVectorElement<T>::bbUserSetDefaultValues()
  86   {
  87
  88   }
  89   //=================================================================
  90   //=================================================================
  91   template <class T>
  92   void GetVectorElement<T>::bbUserInitializeProcessing()
  93   {
  94
  95   }
  96   //=================================================================
  97   //=================================================================
  98   template <class T>
  99   void GetVectorElement<T>::bbUserFinalizeProcessing()
 100   {
 101
 102   }
 103   //=================================================================
 104
 105 } // namespace bbstd
 106
 107 #endif //__bbstdGetVectorElement_INCLUDED_h__
 108