kernel/src/bbtkComplexBlackBoxOutputDescriptor.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkComplexBlackBoxOutputDescriptor.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/04/08 06:59:30 $
   7   Version:   $Revision: 1.3 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 /**
  20  *  \file
  21  *  \brief Class bbtk::ComplexBlackBoxOutputDescriptor : structure containing the description of a ComplexBlackBox output (name, description, type, mapping)
  22  */
  23 /**
  24  * \class bbtk::ComplexBlackBoxOutputDescriptor
  25  * \brief Structure containing the description of a ComplexBlackBox output (name, description, type, mapping)
  26  */
  27
  28 #ifndef __bbtkComplexBlackBoxOutputDescriptor_h__
  29 #define __bbtkComplexBlackBoxOutputDescriptor_h__
  30
  31 #include "bbtkBlackBoxOutputDescriptor.h"
  32 #include "bbtkMessageManager.h"
  33 //#include "bbtkSystem.h"
  34
  35 namespace bbtk
  36 {
  37
  38
  39   class BBTK_EXPORT ComplexBlackBoxOutputDescriptor :
  40     public bbtk::BlackBoxOutputDescriptor
  41   {
  42   public:
  43
  44     ComplexBlackBoxOutputDescriptor( TypeInfo creator_type_info,
  45                                      const std::string& name,
  46                                      const std::string& description,
  47                                      const std::string& nature,
  48                                      const std::string& target,
  49                                      const std::string& output,
  50                                      TypeInfo type);
  51
  52     ~ComplexBlackBoxOutputDescriptor();
  53
  54     /// Returns the type of the output
  55     TypeInfo GetTypeInfo() const { return mType; }
  56     /// Returns the name of the type of the output
  57     std::string GetTypeName() const { return TypeName(mType); }
  58     /// Returns the name of the type of the output
  59     std::string GetHumanTypeName() const { return HumanTypeName(mType); }
  60     ///
  61     bool IsPointerType() const { return false; }
  62
  63
  64     /// Returns the target black box
  65     const std::string& GetTarget() const { return mTarget; }
  66     /// Returns the output
  67     const std::string& GetOutput() const { return mOutput; }
  68
  69   private:
  70     /// Default ctor is private
  71     ComplexBlackBoxOutputDescriptor() :
  72       BlackBoxOutputDescriptor(typeid(void),"","",""),
  73       mType(typeid(void))  {}
  74     std::string mTarget;
  75     std::string mOutput;
  76     TypeInfo mType;
  77   };
  78
  79 }
  80 // namespace bbtk
  81 #endif