kernel/src/bbtkItkBlackBoxMacros.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkItkBlackBoxMacros.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/10/17 08:18:13 $
   6   Version:   $Revision: 1.4 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31
  32
  33 /**
  34  *  \file
  35  *  \brief Defines macros for the creation of itk object inherited black boxes
  36  */
  37 #ifndef __bbtkItkBlackBoxMacros_h__
  38 #define __bbtkItkBlackBoxMacros_h__
  39 //===========================================================================
  40 //============================================================================
  41 // ITK Specific macros
  42 //===========================================================================
  43 //===========================================================================
  44
  45 //===========================================================================
  46 #define BBTK_ITK_DELETE()                                               \
  47   void bbDelete() {                                                     \
  48     itkParent::UnRegister();                                            \
  49   }
  50 //===========================================================================
  51
  52 //===========================================================================
  53 #define BBTK_ITK_BLACK_BOX_INTERFACE(CLASS,PARENTBLACKBOX,ITKPARENT)    \
  54   BBTK_BLACK_BOX_INTERFACE(CLASS,PARENTBLACKBOX);                       \
  55   typedef ITKPARENT itkParent;                                          \
  56   BBTK_ITK_DELETE();
  57 //===========================================================================
  58
  59 //===========================================================================
  60 /// Declares an itk-inherited AtomicBlackBox input
  61 #define BBTK_DECLARE_ITK_INPUT(NAME,TYPE)                               \
  62   public:                                                               \
  63   TYPE bbGetInput##NAME ()                                              \
  64   { return itkParent::GetInput(); }                                     \
  65   void bbSetInput##NAME (TYPE d)                                        \
  66   { itkParent::SetInput(d);                                             \
  67     /*bbSetModifiedStatus();*/ }
  68 //===========================================================================
  69
  70 //===========================================================================
  71 #define BBTK_DECLARE_ITK_OUTPUT(NAME,TYPE)                      \
  72   public:                                                               \
  73   TYPE bbGetOutput##NAME ()                                             \
  74   { return itkParent::GetOutput(); }                                    \
  75   void bbSetOutput##NAME (TYPE d)                                       \
  76   { /*PARENT::GetOutput() = d;*/ }
  77 //===========================================================================
  78
  79 //===========================================================================
  80 /// Declares an AtomicBlackBox input corresponding to an inherited itk parameter
  81 /// which was declared by itkSetMacro/itkGetMacro
  82 /// The NAME **MUST** be the same than the itk parameter name
  83 #define BBTK_DECLARE_ITK_PARAM(NAME,TYPE)                       \
  84   public:                                                               \
  85   TYPE bbGetInput##NAME ()                                              \
  86   { return itkParent::Get##NAME(); }                                    \
  87   void bbSetInput##NAME (TYPE d)                                        \
  88   { itkParent::Set##NAME(d);                                            \
  89     /*bbSetModifiedStatus();*/ }
  90 //===========================================================================
  91
  92 //============================================================================
  93 /// Defines the default bbUserProcess method for itk inherited black boxes
  94 /// (calls itkParent::Update)
  95 #define BBTK_ITK_PROCESS()                                              \
  96   public:                                                               \
  97   inline void bbUserProcess()                                           \
  98   {                                                                     \
  99     bbtkDebugMessage("process",1,"**> Processing ["<<bbGetFullName()    \
 100                      <<"]"<<std::endl);                                 \
 101     itkParent::Update();                                                \
 102     bbtkDebugMessage("process",2,"<** Processing ["<<bbGetFullName()    \
 103                      <<"]"<<std::endl);                                 \
 104   }
 105 //============================================================================
 106
 107 //===========================================================================
 108 /// EOF
 109 //===========================================================================
 110 #endif