kernel/src/bbtkUserBlackBoxDescriptor.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbtkUserBlackBoxDescriptor.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::UserBlackBoxDescriptor : structure containing the description of a UserBlackBox input (name, description, type, functor)
  22  */
  23 /**
  24  * \class bbtk::UserBlackBoxDescriptor
  25  * \brief Structure containing the description of a UserBlackBox input (name, description, type, functor)
  26  */
  27
  28 #ifndef __bbtkUserBlackBoxDescriptor_h__
  29 #define __bbtkUserBlackBoxDescriptor_h__
  30
  31 #include "bbtkBlackBoxDescriptor.h"
  32 #include "bbtkUserBlackBoxInputDescriptor.h"
  33 #include "bbtkUserBlackBoxOutputDescriptor.h"
  34
  35 namespace bbtk
  36 {
  37
  38
  39   class BBTK_EXPORT UserBlackBoxDescriptor : public bbtk::BlackBoxDescriptor
  40   {
  41   public:
  42     UserBlackBoxDescriptor()
  43     {
  44       // Creates the input 'BoxProcessMode'
  45       AddInputDescriptor
  46         (new
  47          bbtk::UserBlackBoxInputDescriptor
  48          (typeid(UserBlackBoxDescriptor),
  49           "BoxProcessMode",
  50           "Sets the processing mode of the box (Pipeline | Always | Reactive)",
  51           new bbtk::UserBlackBoxTGetFunctor<BlackBox,std::string,std::string>(&BlackBox::bbGetInputBoxProcessMode),
  52           new bbtk::UserBlackBoxTSetFunctor<BlackBox,std::string,std::string>(&BlackBox::bbSetInputBoxProcessMode) ) );
  53       // Creates the input 'BoxExecute'
  54       AddInputDescriptor
  55         (new
  56          bbtk::UserBlackBoxInputDescriptor
  57          (typeid(UserBlackBoxDescriptor),
  58           "BoxExecute",
  59           "Any signal received by this input executes the box",
  60           new bbtk::UserBlackBoxTGetFunctor<BlackBox,Void,Void>(&BlackBox::bbGetInputBoxExecute),
  61           new bbtk::UserBlackBoxTSetFunctor<BlackBox,Void,Void>(&BlackBox::bbSetInputBoxExecute) ) );
  62       // Creates the output 'BoxChange'
  63       AddOutputDescriptor
  64         (new
  65          bbtk::UserBlackBoxOutputDescriptor
  66          (typeid(UserBlackBoxDescriptor),
  67           "BoxChange",
  68           "Signal modifications of the box",
  69           new bbtk::UserBlackBoxTGetFunctor<BlackBox,Void,Void>(&BlackBox::bbGetOutputBoxChange),
  70           new bbtk::UserBlackBoxTSetFunctor<BlackBox,Void,Void>(&BlackBox::bbSetOutputBoxChange) ) );
  71     }
  72   };
  73
  74 }
  75 // namespace bbtk
  76 #endif