kernel/src/bbtkData.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: bbtkData.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:49:01 $
  33   Version:   $Revision: 1.5 $
  34 =========================================================================*/
  35
  36
  37
  38
  39 /**
  40  *\file
  41  *\brief  Defines Data and DataInfo
  42  *
  43  * Data is bbtk general type exchanged between black boxes (adapted from boost::any).
  44  * 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).
  45  */
  46
  47 #ifndef __bbtkData_h__
  48 #define __bbtkData_h__
  49
  50
  51 #include "bbtkAny.h"
  52 #include "bbtkRTTI.h"
  53
  54 namespace bbtk
  55 {
  56
  57   /// The generic type of "data" exchanged between black boxes
  58   typedef any<thing> Data;
  59
  60   /// 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)
  61   class DataInfo
  62   {
  63   public:
  64     DataInfo( TypeInfo type, const std::string& nature="")
  65       : mType(type), mNature(nature)
  66     {}
  67
  68     ~DataInfo() {}
  69
  70     TypeInfo GetType() const { return mType; }
  71     const std::string& GetNature() const { return mNature; }
  72
  73     /// Equality
  74     bool operator== ( const DataInfo& k ) const
  75       {
  76         return ( (mType == k.mType)  &&
  77                  (mNature == k.mNature) );
  78       }
  79     /// Comparison
  80     bool operator< ( const DataInfo& k ) const
  81       {
  82         return ( ( mType.before(k.mType) ) ||
  83                  ( ( mType == k.mType ) &&
  84                    ( mNature.compare(k.mNature) < 0 ) ) );
  85       }
  86
  87
  88   private:
  89     DataInfo() : mType(typeid(void)), mNature("") {}
  90     TypeInfo mType;
  91     std::string mNature;
  92
  93   };
  94
  95
  96   /// dump in a stream
  97   inline std::ostream& operator<<(std::ostream& s, const DataInfo& d)
  98   {
  99     s << "<" << TypeName(d.GetType()) << "("<< d.GetNature()<<")>";
 100     return s;
 101   }
 102
 103
 104
 105 }// namespace bbtk
 106
 107 #endif
 108