kernel/src/bbtkComplexBlackBoxOutputDescriptor.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkComplexBlackBoxOutputDescriptor.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/01/22 15:02:00 $
   7   Version:   $Revision: 1.1 $
   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 : public bbtk::BlackBoxOutputDescriptor
  40   {
  41   public:
  42
  43     ComplexBlackBoxOutputDescriptor( const std::string& name,
  44                                      const std::string& description,
  45                                      const std::string& target,
  46                                      const std::string& output,
  47                                      TypeInfo type);
  48
  49     ~ComplexBlackBoxOutputDescriptor();
  50
  51     /// Returns the type of the output
  52     TypeInfo GetTypeInfo() const { return mType; }
  53     /// Returns the name of the type of the output
  54     std::string GetTypeName() const { return TypeName(mType); }
  55     /// Returns the name of the type of the output
  56     std::string GetHumanTypeName() const { return HumanTypeName(mType); }
  57     ///
  58     bool IsPointerType() const { return false; }
  59
  60
  61     /// Returns the target black box
  62     const std::string& GetTarget() const { return mTarget; }
  63     /// Returns the output
  64     const std::string& GetOutput() const { return mOutput; }
  65
  66   private:
  67     /// Default ctor is private
  68     ComplexBlackBoxOutputDescriptor() :
  69       BlackBoxOutputDescriptor("",""), mType(typeid(void))  {}
  70     std::string mTarget;
  71     std::string mOutput;
  72     TypeInfo mType;
  73   };
  74
  75 }
  76 // namespace bbtk
  77 #endif