]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkBlackBoxInputOutputDescriptor.h
#3174 BBTK Bug New Normal - boost in fedore 26
[bbtk.git] / kernel / src / bbtkBlackBoxInputOutputDescriptor.h
index 4560950cc110ff5d31f9adc178460c06cf88b284..a1b3894b3b588194b60da06529fbc19cfc627260 100644 (file)
@@ -1,28 +1,46 @@
+/*
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ #                        pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ #  This software is governed by the CeCILL-B license under French law and
+ #  abiding by the rules of distribution of free software. You can  use,
+ #  modify and/ or redistribute the software under the terms of the CeCILL-B
+ #  license as circulated by CEA, CNRS and INRIA at the following URL
+ #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+ #  or in the file LICENSE.txt.
+ #
+ #  As a counterpart to the access to the source code and  rights to copy,
+ #  modify and redistribute granted by the license, users are provided only
+ #  with a limited warranty  and the software's author,  the holder of the
+ #  economic rights,  and the successive licensors  have only  limited
+ #  liability.
+ #
+ #  The fact that you are presently reading this means that you have had
+ #  knowledge of the CeCILL-B license and that you accept its terms.
+ # ------------------------------------------------------------------------ */
+
+
 /*=========================================================================
-                                                                                
   Program:   bbtk
   Module:    $RCSfile: bbtkBlackBoxInputOutputDescriptor.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/04 08:04:05 $
-  Version:   $Revision: 1.1 $
-                                                                                
-  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-  l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-                                                                                
-     This software is distributed WITHOUT ANY WARRANTY; without even
-     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-     PURPOSE.  See the above copyright notices for more information.
-                                                                                
+  Date:      $Date: 2012/11/16 08:49:01 $
+  Version:   $Revision: 1.7 $
 =========================================================================*/
 
+
 /**
  *  \file 
- *  \brief Class bbtk::BlackBoxInputOutputDescriptor : abstract descriptor of an input or an output of a black box (has a name, a description and type)
+ *  \brief Class bbtk::BlackBoxInputOutputDescriptor : abstract descriptor of an input or an output of a black box (has a name, description, type and nature)
  */
 /**
  * \class bbtk::BlackBoxInputOutputDescriptor
- * \brief Abstract descriptor of an input or an output of a black box (has a name, a description and type)
+ * \brief Abstract descriptor of an input or an output of a black box (has a name, description, type and nature)
  */
 
 #ifndef __bbtkBlackBoxInputOutputDescriptor_h__
@@ -38,27 +56,37 @@ namespace bbtk
   class BBTK_EXPORT BlackBoxInputOutputDescriptor
   {
   public:
-    /// Ctor with name and description
+    /// Ctor with name, description and naure
     BlackBoxInputOutputDescriptor(TypeInfo creator_type_info,
                                  const std::string& name,
                                  const std::string& description,
-                                 bool copy_construct = true)
+                                 const std::string& nature,
+                                 bool copy_construct = true
+                                 )
       : mCreatorTypeInfo(creator_type_info),
        mName(name), 
        mDescription(description),
+       mNature(nature),
        mCopyConstruct(copy_construct)
     {}
-    
+    /// Dtor
+    virtual ~BlackBoxInputOutputDescriptor() {}
+
     /// Returns the TypeInfo of the BlackBoxDescriptor which created this descriptor
-    TypeInfo GetCreatorTypeInfo() { return mCreatorTypeInfo; }
+    TypeInfo GetCreatorTypeInfo() const { return mCreatorTypeInfo; }
     /// Returns the name of the in/output
     const std::string& GetName() const { return mName; }
     /// Returns the description of the in/output
     const std::string& GetDescription() const { return mDescription; }
+    /// Returns the nature of the in/output
+    const std::string& GetNature() const { return mNature; }
     /// Returns the type of the in/output
     virtual TypeInfo GetTypeInfo() const = 0;
     /// Returns the name of the type of the in/output
     virtual std::string GetTypeName() const = 0;
+    /// Returns the DataInfo of the input (Type+Nature)
+    virtual DataInfo GetDataInfo() const 
+    { return DataInfo(this->GetTypeInfo(),mNature); }
     /// Returns the name of the type of the in/output
     virtual std::string GetHumanTypeName() const = 0;
     /// Returns true iff the type is a pointer to class 
@@ -71,6 +99,7 @@ namespace bbtk
     /// Default ctor is reserved to children
     BlackBoxInputOutputDescriptor() : mCreatorTypeInfo(typeid(void)),
                                      mName(""), mDescription(""),
+                                     mNature(""),
                                      mCopyConstruct(true)
                                {}
   private:
@@ -81,6 +110,8 @@ namespace bbtk
     std::string mName;
     /// The description of the input/output
     std::string mDescription;
+    /// The nature of the input/output
+    std::string mNature;
     /// Does the in/output has to be copied by copy constructor 
     /// default = true. Must be set to false if it is 
     /// initialized by the user in bbUserCopyConstructor