]> Creatis software - bbtk.git/blob - packages/std/src/bbstdVectorToString.h
a493ce6bb4a133b6dbfb35a20519c516bf461fb9
[bbtk.git] / packages / std / src / bbstdVectorToString.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbstdVectorToString.h,v $
4   Language:  C++
5   Date:      $Date: 2009/05/14 14:43:38 $
6   Version:   $Revision: 1.9 $
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
33 #ifndef __bbstdVectorToString_INCLUDED_h__
34 #define __bbstdVectorToString_INCLUDED_h__
35
36 #include "bbtkAtomicBlackBox.h"
37 #include "bbstd_EXPORT.h"
38
39 namespace bbstd
40 {
41   //=================================================================
42   // BlackBox declaration
43   template <class T>
44   class bbstd_EXPORT VectorToString : public bbtk::AtomicBlackBox
45   {  
46     BBTK_TEMPLATE_BLACK_BOX_INTERFACE(VectorToString,bbtk::AtomicBlackBox,T);
47     BBTK_DECLARE_INPUT(In,std::vector<T>);
48     BBTK_DECLARE_INPUT(Separator,std::string);
49     BBTK_DECLARE_OUTPUT(Out,std::string);
50     BBTK_PROCESS(DoIt);
51     void DoIt(); 
52   };
53   //=================================================================
54
55   //=================================================================
56   // BlackBox description
57   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(VectorToString,bbtk::AtomicBlackBox);
58   BBTK_NAME(bbtk::HumanTypeName<std::vector<T> >()+"ToString");
59   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
60   BBTK_DEFAULT_ADAPTOR();
61   BBTK_DESCRIPTION("Converts the content of the input vector ("+bbtk::TypeName<std::vector<T> >()+") to a string in which each item is separated by the value of the input 'Separator'");
62   typedef std::vector<T> Tvector;
63   BBTK_TEMPLATE_INPUT(VectorToString, In,"Input",Tvector);
64   BBTK_TEMPLATE_INPUT(VectorToString, Separator,"Separator of item in the output string. Default is whitespace.",std::string);
65   BBTK_TEMPLATE_OUTPUT(VectorToString, Out,"Output",std::string);
66   BBTK_END_DESCRIBE_TEMPLATE_BLACK_BOX(VectorToString);
67   //=================================================================
68
69  //=================================================================
70   template <class T>
71   void VectorToString<T>::DoIt()
72   {
73     std::string out;
74     typename std::vector<T>::const_iterator i;
75     for (i=bbmInputIn.begin();i!=bbmInputIn.end();++i)
76     {
77       if (i!=bbmInputIn.begin())
78          out += bbGetInputSeparator();
79       std::ostringstream s;
80       s <<  *i;
81       out += s.str();
82     }
83     bbSetOutputOut(out);
84   }
85   //=================================================================
86
87   //=================================================================  
88   template <class T>
89   void VectorToString<T>::bbUserSetDefaultValues()
90   {
91     bbSetInputSeparator(" ");
92   }
93   //=================================================================
94   template <class T>
95   void VectorToString<T>::bbUserInitializeProcessing() 
96   { 
97   }
98   //=================================================================
99   template <class T>
100   void VectorToString<T>::bbUserFinalizeProcessing() 
101   {
102   }
103   //=================================================================
104 } // namespace bbstd
105
106 #endif //__bbstdVectorToString_INCLUDED_h__
107