]> Creatis software - bbtk.git/blob - packages/std/src/bbstdSetElementVector.h
#3485 New box AddStringToVector
[bbtk.git] / packages / std / src / bbstdSetElementVector.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 __bbstdSetElementVector_INCLUDED_h__
38 #define __bbstdSetElementVector_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 SetElementVector : public bbtk::AtomicBlackBox
49   {
50     BBTK_TEMPLATE_BLACK_BOX_INTERFACE(SetElementVector,bbtk::AtomicBlackBox,T);
51     BBTK_DECLARE_INPUT(PVec,std::vector<T>*);
52     BBTK_DECLARE_INPUT(I,int);
53     BBTK_DECLARE_INPUT(Value,T);
54     BBTK_DECLARE_OUTPUT(Vec,std::vector<T>);
55     BBTK_DECLARE_OUTPUT(PVec,std::vector<T>*);
56     BBTK_PROCESS(DoIt);
57     void DoIt();
58   };
59   //=================================================================
60
61   //=================================================================
62   // BlackBox description
63   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(SetElementVector,bbtk::AtomicBlackBox);
64   BBTK_NAME("SetElementVector"+bbtk::HumanTypeName<std::vector<T> >());
65   BBTK_AUTHOR("info-dev@creatis.insa-lyon.fr");
66  // BBTK_DEFAULT_ADAPTOR();
67   BBTK_DESCRIPTION("Sets the value of the i-element ("+bbtk::TypeName<std::vector<T> >());
68   typedef std::vector<T>* pTvector;
69   BBTK_TEMPLATE_INPUT(SetElementVector, PVec,"Pointer to Vector",pTvector);
70   BBTK_TEMPLATE_INPUT(SetElementVector, I, "id-element (default 0)",int);  
71   BBTK_TEMPLATE_INPUT(SetElementVector, Value, "Input Value",T);  
72   BBTK_TEMPLATE_OUTPUT(SetElementVector,Vec,"Output Vector",std::vector<T>);
73   BBTK_TEMPLATE_OUTPUT(SetElementVector,PVec,"Pointer to Vector (the same as the input)",pTvector);
74   BBTK_END_DESCRIBE_TEMPLATE_BLACK_BOX(SetElementVector);
75   //=================================================================
76
77   //=================================================================
78   template <class T>
79   void SetElementVector<T>::DoIt()
80   {     
81         if ( (bbGetInputI()>=0) && (bbGetInputI()<bbGetInputPVec()->size()) )   
82         {
83                 (*( bbGetInputPVec() ))[ bbGetInputI() ] = bbGetInputValue();
84         }
85     bbSetOutputVec( *( bbGetInputPVec() ) );
86     bbSetOutputPVec( bbGetInputPVec() );
87 //      bbSignalOutputModification(std::string("Vec"));
88   }
89   //=================================================================
90
91   //=================================================================  
92   template <class T>
93   void SetElementVector<T>::bbUserSetDefaultValues()
94   {
95         bbSetInputI(0);
96   }
97   //=================================================================
98   //=================================================================  
99   template <class T>
100   void SetElementVector<T>::bbUserInitializeProcessing()
101   {
102
103   }
104   //=================================================================
105   //=================================================================  
106   template <class T>
107   void SetElementVector<T>::bbUserFinalizeProcessing()
108   {
109
110   }
111   //=================================================================
112
113 } // namespace bbstd
114
115 #endif //__bbstdSetElementVector_INCLUDED_h__
116