]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkBlackBoxInputDescriptor.h
Feature #1774
[bbtk.git] / kernel / src / bbtkBlackBoxInputDescriptor.h
index 0462c0ccc9519749a2e45861e09fbe57b17d29ee..c36db2b5a88a9ace6197c07c57aca7be8529b9b1 100644 (file)
@@ -1,42 +1,57 @@
+/*
+ # ---------------------------------------------------------------------
+ #
+ # 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: bbtkBlackBoxInputDescriptor.h,v $
   Language:  C++
-  Date:      $Date: 2008/01/22 15:02:00 $
-  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.6 $
 =========================================================================*/
 
+
 /**
  *  \file 
- *  \brief Class bbtk::BlackBoxInputDescriptor : abstract descriptor of an input of a black box (stores a name, a description and type)
+ *  \brief Class bbtk::BlackBoxInputDescriptor : abstract descriptor of an input of a black box 
  */
 /**
  * \class bbtk::BlackBoxInputDescriptor
- * \brief Abstract descriptor of an input of a black box (stores a name, a description and type)
+ * \brief Abstract descriptor of an input of a black box 
  */
 
 #ifndef __bbtkBlackBoxInputDescriptor_h__
 #define __bbtkBlackBoxInputDescriptor_h__
 
-#include "bbtkSystem.h"
-#include "bbtkData.h"
-#include "bbtkRTTI.h"
+#include "bbtkBlackBoxInputOutputDescriptor.h"
 
 namespace bbtk
 {
-  
-  
-  class BBTK_EXPORT BlackBoxInputDescriptor
+  class BBTK_EXPORT BlackBoxInputDescriptor 
+    : public BlackBoxInputOutputDescriptor
   {
   public:
     typedef enum {
@@ -46,47 +61,29 @@ namespace bbtk
     
     
     /// Ctor with name and description
-    BlackBoxInputDescriptor( const std::string& name,
-                            const std::string& description,
-                            OptionType option = MANDATORY,
-                            bool copy_construct = true)
-      : mName(name), mDescription(description), 
-       mOption(option), mCopyConstruct(copy_construct) 
+    BlackBoxInputDescriptor(TypeInfo creator_type_info,
+                           const std::string& name,
+                           const std::string& description,
+                           const std::string& nature,
+                           bool copy_construct = true,
+                           OptionType option = MANDATORY
+                           )
+      : BlackBoxInputOutputDescriptor(creator_type_info,name,
+                                     description,nature,
+                                     copy_construct),
+       mOption(option)
     {}
-    
-    /// Returns the name of the input
-    const std::string& GetName() const { return mName; }
-    /// Returns the description of the input
-    const std::string& GetDescription() const { return mDescription; }
-    /// Returns the type of the input
-    virtual TypeInfo GetTypeInfo() const = 0;
-    /// Returns the name of the type of the input
-    virtual std::string GetTypeName() const = 0;
-    /// Returns the name of the type of the input
-    virtual std::string GetHumanTypeName() const = 0;
-    /// Returns true iff the type is a pointer to class 
-    virtual bool IsPointerType() const = 0;
     /// Returns the option of the input
     OptionType GetOption() const { return mOption; }
-    /// Returns true iff the input must be copied 
-    /// by the copy constructor of the box
-    bool GetCopyConstruct() const { return mCopyConstruct; }
     
-  private:
-    /// Default ctor is private
-    BlackBoxInputDescriptor() : mName(""), mDescription(""), 
+  protected:
+    /// Default ctor is reserved to children
+    BlackBoxInputDescriptor() : BlackBoxInputOutputDescriptor(),
                                mOption(OPTIONAL) {}
-    /// The name of the input
-    std::string mName;
-    /// The description of the input
-    std::string mDescription;
+
+  private:
     /// The option of the input 
     OptionType mOption;
-    /// Does the input has to be copied by copy constructor 
-    /// default = true. Must be set to false if it is 
-    /// initialized by the user in bbUserCopyConstructor 
-    /// (typically if it is a pointer)
-    bool mCopyConstruct;
   };
   
 }