/*========================================================================= Program: bbtk Module: $RCSfile: bbtkAtomicBlackBoxMacros.h,v $ Language: C++ Date: $Date: 2008/04/09 11:16:56 $ Version: $Revision: 1.4 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the above copyright notices for more information. =========================================================================*/ /** * \file * \brief Defines macros for the creation of new user black boxes */ #ifndef __bbtkAtomicBlackBoxMacros_h__ #define __bbtkAtomicBlackBoxMacros_h__ //============================================================================ /// Declares the standard interface of a AtomicBlackBox /// (ctor, New, descriptor related methods) #define BBTK_USER_BLACK_BOX_INTERFACE(CLASS,PARENT) \ private: \ inline static void bbCreateDescriptorIfNeeded(); \ protected: \ CLASS(const std::string& name, bool allocate_connectors = true); \ CLASS(CLASS& from, const std::string& name, \ bool allocate_connectors = true); \ ~CLASS(); \ public: \ inline static CLASS* bbNew(const std::string& name) \ { \ bbtkDebugMessageInc("Kernel",9,#CLASS<<"::bbNew(\""<bbGetDescriptor()->Reference(); \ bbtkDebugDecTab("Kernel",9); \ return c; \ } \ inline bbtk::BlackBox* bbClone(const std::string& name) \ { \ bbtkDebugMessageInc("Kernel",9,#CLASS<<"::bbClone(\""<Reference(); \ bbtkDebugDecTab("Kernel",9); \ return c; \ } \ bbtk::BlackBoxDescriptor* bbGetDescriptor() const \ { \ return (bbtk::BlackBoxDescriptor*)bbDescriptor(); \ } \ static bbtk::BlackBoxDescriptor* bbDescriptor() \ { \ bbCreateDescriptorIfNeeded(); \ return bbDescriptorPointer(); \ } \ private: \ CLASS() : PARENT("") {} \ static bbtk::BlackBoxDescriptor*& bbDescriptorPointer() \ { \ static bbtk::BlackBoxDescriptor* d = 0; \ return d; \ } //============================================================================ //============================================================================ /// Defines the bbUserProcess method #define BBTK_PROCESS(CALLBACK) \ public: \ inline void bbUserProcess() \ { \ bbtkDebugMessageInc("Process",1,"=> "<bbGetFullName()<<"]"< \ (&CLASS::bbGetInput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor \ (&CLASS::bbSetInput##NAME) ) ) //============================================================================ //============================================================================ /// Describes a AtomicBlackBox output (to be put inside the UBB description block) #define BBTK_OUTPUT(CLASS,NAME,DESCR,TYPE,NATURE) \ AddOutputDescriptor(new bbtk::AtomicBlackBoxOutputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,NATURE, \ new bbtk::AtomicBlackBoxTGetFunctor \ (&CLASS::bbGetOutput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor \ (&CLASS::bbSetOutput##NAME) ) ) //============================================================================ //============================================================================ /// Describes a AtomicBlackBox input (to be put inside the UBB description block) #define BBTK_INPUT_NOCOPY(CLASS,NAME,DESCR,TYPE,NATURE) \ AddInputDescriptor(new bbtk::AtomicBlackBoxInputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,NATURE, \ new bbtk::AtomicBlackBoxTGetFunctor \ (&CLASS::bbGetInput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor \ (&CLASS::bbSetInput##NAME), \ false) ) //============================================================================ //============================================================================ /// Describes a AtomicBlackBox output (to be put inside the UBB description block) #define BBTK_OUTPUT_NOCOPY(CLASS,NAME,DESCR,TYPE,NATURE) \ AddOutputDescriptor(new bbtk::AtomicBlackBoxOutputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,NATURE, \ new bbtk::AtomicBlackBoxTGetFunctor \ (&CLASS::bbGetOutput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor \ (&CLASS::bbSetOutput##NAME),\ false) ) //============================================================================ //============================================================================ //============================================================================ // Template user black boxes macros //============================================================================ //============================================================================ //============================================================================ /// Begins a template AtomicBlackBox of template param T description block #define BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(CLASS) \ template \ class /*BBTK_EXPORT*/ CLASS ## Descriptor : public bbtk::BlackBoxDescriptor \ { \ public: \ bbtk::BlackBox::Pointer CreateInstance(const std::string& name) \ { \ return CLASS::bbNew(name); \ } \ CLASS ## Descriptor() \ { \ bbtkDebugMessageInc("Kernel",9,#CLASS<<"Descriptor::"<<#CLASS \ <<"Descriptor()"< \ void CLASS::bbCreateDescriptorIfNeeded() \ { \ if ( !bbDescriptorPointer() ) \ bbDescriptorPointer() = new CLASS ## Descriptor; \ } //============================================================================ //============================================================================ /// Describes a template AtomicBlackBox input (to be put inside the template UBB description block) #define BBTK_TEMPLATE_INPUT(CLASS,NAME,DESCR,TYPE) \ AddInputDescriptor(new bbtk::AtomicBlackBoxInputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,"", \ new bbtk::AtomicBlackBoxTGetFunctor,TYPE,TYPE > \ (&CLASS::bbGetInput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor,TYPE,TYPE > \ (&CLASS::bbSetInput##NAME) ) ) //============================================================================ //============================================================================ /// Describes a template AtomicBlackBox output (to be put inside the template UBB description block) #define BBTK_TEMPLATE_OUTPUT(CLASS,NAME,DESCR,TYPE) \ AddOutputDescriptor(new bbtk::AtomicBlackBoxOutputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,"", \ new bbtk::AtomicBlackBoxTGetFunctor,TYPE,TYPE > \ (&CLASS::bbGetOutput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor,TYPE,TYPE > \ (&CLASS::bbSetOutput##NAME) ) ) //============================================================================ //============================================================================ /// Template AtomicBlackBox std implementation of ctor and dtor #define BBTK_USER_BLACK_BOX_TEMPLATE_IMPLEMENTATION(CLASS,PARENT) \ template \ CLASS::CLASS(const std::string& name, bool alloc) \ : PARENT(name,false) \ { \ BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,alloc); \ CLASS::bbUserConstructor(); \ BBTK_END_BLACK_BOX_CONSTRUCTOR; \ } \ template \ CLASS::CLASS(CLASS& from, \ const std::string& name, bool allocate_connectors) \ : PARENT(from,name,false) \ { \ BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \ CLASS::bbUserCopyConstructor(); \ BBTK_END_BLACK_BOX_CONSTRUCTOR; \ } \ template \ CLASS::~CLASS() \ { \ BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \ CLASS::bbUserDestructor(); \ BBTK_END_BLACK_BOX_DESTRUCTOR; \ } //============================================================================ //============================================================================ // Two template params user black boxes macros /// Begins a template AtomicBlackBox description block of template param T1 and T2 #define BBTK_BEGIN_DESCRIBE_TEMPLATE2_BLACK_BOX(CLASS) \ template \ class /*BBTK_EXPORT*/ CLASS ## Descriptor : public bbtk::BlackBoxDescriptor \ { \ public: \ bbtk::BlackBox::Pointer CreateInstance(const std::string& name) \ { \ return CLASS::bbNew(name); \ } \ CLASS ## Descriptor() \ { \ bbtkDebugMessageInc("Kernel",9,#CLASS<<"Descriptor::"<<#CLASS \ <<"Descriptor()"< \ void CLASS::bbCreateDescriptorIfNeeded() \ { \ if ( !bbDescriptorPointer() ) \ bbDescriptorPointer() = new CLASS ## Descriptor; \ } //============================================================================ //============================================================================ // Two template params user black boxes macros /// Begins a template AtomicBlackBox description block of template param T1 and T2 #define BBTK_BEGIN_DESCRIBE_TEMPLATE2_WITH_TYPES_BLACK_BOX(CLASS,TYPE1,TYPE2) \ template \ class /*BBTK_EXPORT*/ CLASS ## Descriptor : public bbtk::BlackBoxDescriptor \ { \ public: \ bbtk::BlackBox::Pointer CreateInstance(const std::string& name) \ { \ return new CLASS(name); \ } \ CLASS ## Descriptor() \ { \ bbtkDebugMessageInc("Kernel",9,#CLASS<<"Descriptor::"<<#CLASS \ <<"Descriptor()"< \ void CLASS::bbCreateDescriptorIfNeeded() \ { \ if ( !bbDescriptorPointer() ) \ bbDescriptorPointer() = new CLASS ## Descriptor; \ } //============================================================================ //============================================================================ /// Describes a 2 template params AtomicBlackBox input (to be put inside the UBB description block) #define BBTK_TEMPLATE2_INPUT(CLASS,NAME,DESCR,TYPE) \ AddInputDescriptor(new bbtk::AtomicBlackBoxInputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,"", \ new bbtk::AtomicBlackBoxTGetFunctor,TYPE,TYPE > \ (&CLASS::bbGetInput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor,TYPE,TYPE > \ (&CLASS::bbSetInput##NAME) ) ) //============================================================================ //============================================================================ /// Describes a 2 template params AtomicBlackBox output (to be put inside the UBB description block) #define BBTK_TEMPLATE2_OUTPUT(CLASS,NAME,DESCR,TYPE) \ AddOutputDescriptor(new bbtk::AtomicBlackBoxOutputDescriptor \ (typeid(CLASS ## Descriptor),#NAME,DESCR,"", \ new bbtk::AtomicBlackBoxTGetFunctor,TYPE,TYPE > \ (&CLASS::bbGetOutput##NAME), \ new bbtk::AtomicBlackBoxTSetFunctor,TYPE,TYPE > \ (&CLASS::bbSetOutput##NAME) ) ) //============================================================================ //============================================================================ /// Template AtomicBlackBox std implementation of ctor and dtor #define BBTK_USER_BLACK_BOX_TEMPLATE2_IMPLEMENTATION(CLASS,PARENT) \ template \ CLASS::CLASS(const std::string& name, bool alloc) \ : PARENT(name,false) \ { \ BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,alloc); \ CLASS::bbUserConstructor(); \ BBTK_END_BLACK_BOX_CONSTRUCTOR; \ } \ template \ CLASS::CLASS(CLASS& from, \ const std::string& name, bool allocate_connectors) \ : PARENT(from,name,false) \ { \ BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \ CLASS::bbUserCopyConstructor(); \ BBTK_END_BLACK_BOX_CONSTRUCTOR; \ } \ template \ CLASS::~CLASS() \ { \ BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \ CLASS::bbUserDestructor(); \ BBTK_END_BLACK_BOX_DESTRUCTOR; \ } //============================================================================ //============================================================================ /// Template AtomicBlackBox std implementation of ctor and dtor #define BBTK_USER_BLACK_BOX_TEMPLATE2_WITH_TYPES_IMPLEMENTATION(CLASS,PARENT,TYPE1,TYPE2) \ template \ CLASS::CLASS(const std::string& name, bool alloc) \ : PARENT(name,false) \ { \ BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,alloc); \ this->bbUserConstructor(); \ BBTK_END_BLACK_BOX_CONSTRUCTOR; \ } \ template \ CLASS::CLASS(CLASS& from, \ const std::string& name, bool allocate_connectors) \ : PARENT(from,name,false) \ { \ BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \ this->bbUserCopyConstructor(); \ BBTK_END_BLACK_BOX_CONSTRUCTOR; \ } \ template \ CLASS::~CLASS() \ { \ BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \ this->bbUserDestructor(); \ BBTK_END_BLACK_BOX_DESTRUCTOR; \ } //============================================================================ //=========================================================================== //============================================================================ // ITK Specific macros //=========================================================================== //=========================================================================== //=========================================================================== /// Declares an itk-inherited AtomicBlackBox input #define BBTK_DECLARE_ITK_INPUT(PARENT,NAME,TYPE) \ public: \ TYPE bbGetInput##NAME () \ { return PARENT::GetInput(); } \ void bbSetInput##NAME (TYPE d) \ { PARENT::SetInput(d); \ /*bbSetModifiedStatus();*/ } //=========================================================================== //=========================================================================== #define BBTK_DECLARE_ITK_OUTPUT(PARENT,NAME,TYPE) \ public: \ TYPE bbGetOutput##NAME () \ { return PARENT::GetOutput(); } \ void bbSetOutput##NAME (TYPE d) \ { /*PARENT::GetOutput() = d;*/ } //=========================================================================== //=========================================================================== /// Declares an AtomicBlackBox input corresponding to an inherited itk parameter /// which was declared by itkSetMacro/itkGetMacro /// The NAME **MUST** be the same than the itk parameter name #define BBTK_DECLARE_ITK_PARAM(PARENT,NAME,TYPE) \ public: \ TYPE bbGetInput##NAME () \ { return PARENT::Get##NAME(); } \ void bbSetInput##NAME (TYPE d) \ { PARENT::Set##NAME(d); \ /*bbSetModifiedStatus();*/ } //=========================================================================== //=========================================================================== //============================================================================ // VTK Specific macros //=========================================================================== //=========================================================================== //=========================================================================== // EED sept 04 \ // { return GetInput(); /*PARENT::GetInput();*/ } \ // { PARENT::SetInput( /*(vtkDataObject*)*/ d); \ /// Declares a vtkImageAlgorithm-inherited AtomicBlackBox input #define BBTK_DECLARE_VTK_IMAGE_ALGORITHM_INPUT(PARENT,NAME,TYPE) \ public: \ TYPE bbGetInput##NAME () \ { return GetImageDataInput(0); /*PARENT::GetInput();*/ } \ void bbSetInput##NAME (TYPE d) \ { PARENT::SetInput( (vtkDataObject*) d); \ /*bbSetModifiedStatus();*/ } //=========================================================================== /// Declares a vtkPolyDataAlgorithm-inherited AtomicBlackBox input #define BBTK_DECLARE_VTK_POLY_DATA_ALGORITHM_INPUT(PARENT,NAME,TYPE) \ public: \ TYPE bbGetInput##NAME () \ { return GetPolyDataInput(0); /*PARENT::GetInput();*/ } \ void bbSetInput##NAME (TYPE d) \ { PARENT::SetInput( (vtkDataObject*) d); \ /*bbSetModifiedStatus();*/ } //=========================================================================== //=========================================================================== /// Declares a vtkImageAlgorithm-inherited AtomicBlackBox output #define BBTK_DECLARE_VTK_OUTPUT(PARENT,NAME,TYPE) \ public: \ TYPE bbGetOutput##NAME () \ { return PARENT::GetOutput(); } \ void bbSetOutput##NAME (TYPE d) \ { /*PARENT::GetOutput() = d;*/ } //=========================================================================== //=========================================================================== /// Declares a vtkAlgorithm-inherited AtomicBlackBox input #define BBTK_DECLARE_VTK_INPUT(PARENT,NAME,TYPE) \ public: \ TYPE bbGetInput##NAME () \ { return dynamic_cast(PARENT::GetInput()); } \ void bbSetInput##NAME (TYPE d) \ { PARENT::SetInput( (vtkDataObject*) d); /*PARENT::GetOutput() = d;*/ } //=========================================================================== //=========================================================================== /// Declares an AtomicBlackBox input corresponding to an inherited vtk parameter /// which was declared by vtkSetMacro/vtkGetMacro /// The NAME **MUST** be the same than the vtk parameter name #define BBTK_DECLARE_VTK_PARAM(PARENT,NAME,TYPE) \ public: \ TYPE bbGetInput##NAME () \ { return PARENT::Get##NAME(); } \ void bbSetInput##NAME (TYPE d) \ { PARENT::Set##NAME(d); \ /*bbSetModifiedStatus();*/ } //=========================================================================== //=========================================================================== /// EOF //=========================================================================== #endif