kernel/src/bbtkComplexBlackBoxInputDescriptor.h

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