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