kernel/src/bbtkUserBlackBoxOutputDescriptor.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkUserBlackBoxOutputDescriptor.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/02/06 14:14:22 $
   7   Version:   $Revision: 1.2 $
   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::UserBlackBoxOutputDescriptor : structure containing the description of a UserBlackBox output (name, description, type, functor)
  22  */
  23 /**
  24  * \class bbtk::UserBlackBoxOutputDescriptor
  25  * \brief Structure containing the description of a UserBlackBox output (name, description, type, functor)
  26  */
  27
  28 #ifndef __bbtkUserBlackBoxOutputDescriptor_h__
  29 #define __bbtkUserBlackBoxOutputDescriptor_h__
  30
  31 #include "bbtkBlackBoxOutputDescriptor.h"
  32 #include "bbtkUserBlackBoxGetSetFunctor.h"
  33 #include "bbtkMessageManager.h"
  34
  35 namespace bbtk
  36 {
  37
  38
  39   class BBTK_EXPORT UserBlackBoxOutputDescriptor :
  40     public bbtk::BlackBoxOutputDescriptor
  41   {
  42   public:
  43
  44     UserBlackBoxOutputDescriptor( TypeInfo creator_type_info,
  45                                   const std::string& name,
  46                                   const std::string& description,
  47                                   UserBlackBoxGetFunctor* getfunctor,
  48                                   UserBlackBoxSetFunctor* setfunctor,
  49                                   bool copy_construct = true);
  50     ~UserBlackBoxOutputDescriptor();
  51
  52     /// Returns the type of the input
  53     TypeInfo GetTypeInfo() const { return mGetFunctor->GetTypeInfo(); }
  54     /// Returns the name of the type of the input
  55     std::string GetTypeName() const { return mGetFunctor->GetTypeName(); }
  56    /// Returns the name of the type of the input
  57     std::string GetHumanTypeName() const { return mGetFunctor->GetHumanTypeName(); }
  58     /// Returns true iff the type is a pointer to class
  59     virtual bool IsPointerType() const { return mGetFunctor->IsPointerType(); }   /// Returns the functor on the Get method
  60     UserBlackBoxGetFunctor* GetGetFunctor() { return mGetFunctor; }
  61     /// Returns the functor on the Set method
  62     UserBlackBoxSetFunctor* GetSetFunctor() { return mSetFunctor; }
  63
  64
  65   private:
  66     /// Default ctor is private
  67     UserBlackBoxOutputDescriptor() :
  68       BlackBoxOutputDescriptor(typeid(void),"","") {}
  69     /// The functor on the Get method
  70     UserBlackBoxGetFunctor* mGetFunctor;
  71     /// The functor on the Set method
  72     UserBlackBoxSetFunctor* mSetFunctor;
  73   };
  74
  75
  76 }
  77 // namespace bbtk
  78 #endif