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