kernel/src/bbtkComplexBlackBoxInputDescriptor.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: bbtkComplexBlackBoxInputDescriptor.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:49:01 $
  33   Version:   $Revision: 1.5 $
  34 =========================================================================*/
  35
  36
  37 /**
  38  *  \file
  39  *  \brief Class bbtk::ComplexBlackBoxInputDescriptor : structure containing the description of a ComplexBlackBox input (name, description, type, mapping)
  40  */
  41 /**
  42  * \class bbtk::ComplexBlackBoxInputDescriptor
  43  * \brief Structure containing the description of a ComplexBlackBox input (name, description, type, mapping)
  44  */
  45
  46 #ifndef __bbtkComplexBlackBoxInputDescriptor_h__
  47 #define __bbtkComplexBlackBoxInputDescriptor_h__
  48
  49 #include "bbtkBlackBoxInputDescriptor.h"
  50 #include "bbtkMessageManager.h"
  51
  52 namespace bbtk
  53 {
  54
  55
  56   class BBTK_EXPORT ComplexBlackBoxInputDescriptor :
  57     public bbtk::BlackBoxInputDescriptor
  58   {
  59   public:
  60
  61     ComplexBlackBoxInputDescriptor( TypeInfo creator_type_info,
  62                                     const std::string& name,
  63                                     const std::string& description,
  64                                     const std::string& nature,
  65                                     const std::string& target,
  66                                     const std::string& input,
  67                                     TypeInfo type);
  68
  69     ~ComplexBlackBoxInputDescriptor();
  70
  71     /// Returns the type of the input
  72     TypeInfo GetTypeInfo() const { return mType; }
  73     /// Returns the name of the type of the input
  74     std::string GetTypeName() const { return TypeName(mType); }
  75     /// Returns the name of the type of the input
  76     std::string GetHumanTypeName() const { return HumanTypeName(mType); }
  77     /// Returns the target black box
  78     const std::string& GetTarget() const { return mTarget; }
  79     /// Returns the input
  80     const std::string& GetInput() const { return mInput; }
  81     ///
  82     bool IsPointerType() const { return false; }
  83
  84
  85   private:
  86     /// Default ctor is private
  87     ComplexBlackBoxInputDescriptor() :
  88       BlackBoxInputDescriptor(typeid(void),"","",""),
  89       mType(typeid(void)) {}
  90     std::string mTarget;
  91     std::string mInput;
  92     TypeInfo mType;
  93   };
  94
  95
  96 }
  97 // namespace bbtk
  98 #endif