]> Creatis software - bbtk.git/blob - kernel/src/bbtkData.h
no message
[bbtk.git] / kernel / src / bbtkData.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbtkData.h,v $
4   Language:  C++
5   Date:      $Date: 2008/10/17 08:18:13 $
6   Version:   $Revision: 1.4 $
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  *\file
34  *\brief  Defines Data and DataInfo 
35  * 
36  * Data is bbtk general type exchanged between black boxes (adapted from boost::any).
37  * DataInfo is the bbtk type of object storing informations on a data type : includes C++ type info (std::type_info) and a string describing the "nature" of the data (what is the content of the structure). 
38  */
39
40 #ifndef __bbtkData_h__
41 #define __bbtkData_h__
42
43
44 #include "bbtkAny.h"
45 #include "bbtkRTTI.h"
46
47 namespace bbtk
48 {
49   
50   /// The generic type of "data" exchanged between black boxes
51   typedef any<thing> Data;
52
53   /// Object storing informations on a data type : includes C++ type info (std::type_info) and a string describing the "nature" of the data (what is the content of the structure)
54   class DataInfo
55   {
56   public:
57     DataInfo( TypeInfo type, const std::string& nature="") 
58       : mType(type), mNature(nature)
59     {}
60
61     ~DataInfo() {}
62
63     TypeInfo GetType() const { return mType; }
64     const std::string& GetNature() const { return mNature; }
65
66     /// Equality
67     bool operator== ( const DataInfo& k ) const
68       {
69         return ( (mType == k.mType)  &&
70                  (mNature == k.mNature) );
71       }
72     /// Comparison
73     bool operator< ( const DataInfo& k ) const
74       {
75         return ( ( mType.before(k.mType) ) ||
76                  ( ( mType == k.mType ) &&
77                    ( mNature.compare(k.mNature) < 0 ) ) );
78       }
79
80
81   private:
82     DataInfo() : mType(typeid(void)), mNature("") {}
83     TypeInfo mType;
84     std::string mNature;
85
86   };
87
88   
89   /// dump in a stream
90   inline std::ostream& operator<<(std::ostream& s, const DataInfo& d) 
91   {
92     s << "<" << TypeName(d.GetType()) << "("<< d.GetNature()<<")>";
93     return s;
94   }
95
96
97
98 }// namespace bbtk
99
100 #endif
101