+/*
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ # pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ # This software is governed by the CeCILL-B license under French law and
+ # abiding by the rules of distribution of free software. You can use,
+ # modify and/ or redistribute the software under the terms of the CeCILL-B
+ # license as circulated by CEA, CNRS and INRIA at the following URL
+ # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+ # or in the file LICENSE.txt.
+ #
+ # As a counterpart to the access to the source code and rights to copy,
+ # modify and redistribute granted by the license, users are provided only
+ # with a limited warranty and the software's author, the holder of the
+ # economic rights, and the successive licensors have only limited
+ # liability.
+ #
+ # The fact that you are presently reading this means that you have had
+ # knowledge of the CeCILL-B license and that you accept its terms.
+ # ------------------------------------------------------------------------ */
+
+
/*=========================================================================
-
Program: bbtk
Module: $RCSfile: bbtkAtomicBlackBoxMacros.h,v $
Language: C++
- Date: $Date: 2008/04/24 10:11:27 $
- Version: $Revision: 1.6 $
-
- 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.
-
+ Date: $Date: 2012/11/16 08:49:01 $
+ Version: $Revision: 1.20 $
=========================================================================*/
+
+
+
/**
* \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_BLACK_BOX_INTERFACE_INTERNAL_WITHOUT_NEW(CLASS,PARENT) \
+ BBTK_OBJECT_MINIMAL_INTERFACE; \
+ private: \
+ protected: \
+ CLASS(const std::string& name, bool allocate_connectors = true); \
+ CLASS(Self& from, const std::string& name, \
+ bool allocate_connectors = true); \
+ ~CLASS(); \
+ public: \
+ std::string GetObjectName() const \
+ { return std::string(#CLASS)+std::string(" '") \
+ +bbGetNameWithParent()+std::string("'"); } \
+ virtual void bbLockDescriptor(); \
+ virtual void bbUserSetDefaultValues(); \
+ virtual void bbUserInitializeProcessing(); \
+ virtual void bbUserFinalizeProcessing(); \
+ virtual void bbRecursiveInitializeProcessing() \
+ { \
+ PARENT::bbRecursiveInitializeProcessing(); \
+ CLASS::bbUserInitializeProcessing(); \
+ } \
+ virtual void bbRecursiveFinalizeProcessing() \
+ { \
+ CLASS::bbUserFinalizeProcessing(); \
+ PARENT::bbRecursiveFinalizeProcessing(); \
+ } \
+ private: \
+ CLASS() : PARENT("") {} \
+ CLASS(const CLASS&) : PARENT("") {}
+
+//============================================================================
+
//============================================================================
/// Declares the standard interface of a AtomicBlackBox
/// (ctor, New, descriptor related methods)
} \
inline bbtk::BlackBox::Pointer bbClone(const std::string& name) \
{ \
- bbtkDebugMessage("object",1,"##> "<<#CLASS \
- <<"::bbClone(\""<<name<<"\")"<<std::endl); \
+ bbtkBlackBoxDebugMessage("object",1,"##> "<<#CLASS \
+ <<"::bbClone(\""<<name<<"\")"<<std::endl); \
Pointer p = MakeBlackBoxPointer(new Self(*this,name)); \
- bbtkDebugMessage("object",1,"<## "<<#CLASS \
+ bbtkBlackBoxDebugMessage("object",1,"<## "<<#CLASS \
<<"::bbClone(\""<<name<<"\")"<<std::endl); \
return p; \
} \
virtual void bbLockDescriptor(); \
+ virtual void bbUserSetDefaultValues(); \
+ virtual void bbUserInitializeProcessing(); \
+ virtual void bbUserFinalizeProcessing(); \
+ virtual void bbRecursiveInitializeProcessing() \
+ { \
+ PARENT::bbRecursiveInitializeProcessing(); \
+ CLASS::bbUserInitializeProcessing(); \
+ } \
+ virtual void bbRecursiveFinalizeProcessing() \
+ { \
+ CLASS::bbUserFinalizeProcessing(); \
+ PARENT::bbRecursiveFinalizeProcessing(); \
+ } \
private: \
CLASS() : PARENT("") {} \
CLASS(const CLASS&) : PARENT("") {}
BBTK_BLACK_BOX_INTERFACE_INTERNAL(CLASS,PARENT);
//============================================================================
+//============================================================================
+#define BBTK_BLACK_BOX_INTERFACE_WITHOUT_NEW(CLASS,PARENT) \
+ public : typedef CLASS Self; \
+ BBTK_BLACK_BOX_INTERFACE_INTERNAL_WITHOUT_NEW(CLASS,PARENT);
+//============================================================================
+
//============================================================================
/// Defines the bbUserProcess method
#define BBTK_PROCESS(CALLBACK) \
public: \
inline void bbUserProcess() \
{ \
- bbtkDebugMessage("process",1,"**> Processing ["<<bbGetFullName() \
- <<"]"<<std::endl); \
+ bbtkBlackBoxDebugMessage("process",1,"**> Processing..." \
+ <<std::endl); \
CALLBACK(); \
- bbtkDebugMessage("process",1,"<** Processing ["<<bbGetFullName() \
- <<"]"<<std::endl); \
+ bbtkBlackBoxDebugMessage("process",1,"<** Processing" \
+ <<std::endl); \
}
//============================================================================
//============================================================================
#define BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,ALLOC) \
- bbtkDebugMessage("object",2,"==> "<<#CLASS<<"::"<<#CLASS \
- <<"(\""<<bbGetName()<<"\")"<<std::endl); \
+ bbtkBlackBoxDebugMessage("object",2,"==> "<<#CLASS<<"::"<<#CLASS \
+ <<"()"<<std::endl); \
if (ALLOC) \
{ \
bbLockDescriptor(); \
bbAllocateConnectors(); \
- }
+ }
+
//============================================================================
//============================================================================
#define BBTK_END_BLACK_BOX_CONSTRUCTOR(CLASS) \
- bbtkDebugMessage("object",2,"<== "<<#CLASS<<"::"<<#CLASS \
- <<"(\""<<bbGetName()<<"\")"<<std::endl);
+ bbtkBlackBoxDebugMessage("object",2,"<== "<<#CLASS<<"::"<<#CLASS \
+ <<"()"<<std::endl);
//============================================================================
//============================================================================
#define BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,FROM,ALLOC) \
- bbtkDebugMessageInc("object",2,"==> "<<#CLASS<<"::"<<#CLASS \
- <<"("<<FROM.bbGetFullName()<<",\"" \
- <<bbGetName()<<"\")"<<std::endl); \
+ bbtkBlackBoxDebugMessage("object",2,"==> "<<#CLASS<<"::"<<#CLASS \
+ <<"("<<FROM.bbGetFullName() \
+ <<")"<<std::endl); \
if (ALLOC) \
{ \
bbLockDescriptor(); \
bbAllocateConnectors(); \
- bbCopyIOValues(FROM); \
- }
+ }
//============================================================================
//============================================================================
-#define BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,FROM) \
- bbtkDebugMessage("object",2,"<== "<<#CLASS<<"::"<<#CLASS \
- <<"("<<FROM.bbGetFullName()<<",\"" \
- <<bbGetName()<<"\")"<<std::endl);
+#define BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,FROM,ALLOC) \
+ bbtkBlackBoxDebugMessage("object",2,"<== "<<#CLASS<<"::"<<#CLASS \
+ <<"("<<FROM.bbGetFullName() \
+ <<")"<<std::endl); \
+ if (ALLOC) \
+ { \
+ bbCopyIOValues(FROM); \
+ }
//============================================================================
//============================================================================
#define BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS) \
- bbtkDebugMessage("object",2,"==> "<<#CLASS <<"::~"<< #CLASS \
- <<"() ["<<this->bbGetFullName()<<"]"<<std::endl);
+ bbtkBlackBoxDebugMessage("object",2,"==> "<<#CLASS <<"::~"<< #CLASS \
+ <<"()"<<std::endl); \
+ bbFinalizeProcessing();
+
+
//============================================================================
//============================================================================
#define BBTK_END_BLACK_BOX_DESTRUCTOR(CLASS) \
- bbtkDebugMessage("object",2,"<== "<<#CLASS <<"::~"<< #CLASS \
- <<"() ["<<this->bbGetFullName()<<"]"<<std::endl);
+ bbtkBlackBoxDebugMessage("object",2,"<== "<<#CLASS <<"::~"<< #CLASS \
+ <<"()"<<std::endl);
//============================================================================
: PARENT(name,false) \
{ \
BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,allocate_connectors); \
- CLASS::bbUserConstructor(); \
+ CLASS::bbUserSetDefaultValues(); \
BBTK_END_BLACK_BOX_CONSTRUCTOR(CLASS); \
} \
CLASS::CLASS(CLASS& from, \
: PARENT(from,name,false) \
{ \
BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \
- CLASS::bbUserCopyConstructor(); \
- BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from); \
+ CLASS::bbUserSetDefaultValues(); \
+ BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \
} \
CLASS::~CLASS() \
{ \
BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \
- CLASS::bbUserDestructor(); \
BBTK_END_BLACK_BOX_DESTRUCTOR(CLASS); \
} \
void CLASS::bbLockDescriptor() \
//============================================================================
/// Begins the AtomicBlackBox description block
-#define BBTK_BEGIN_DESCRIBE_BLACK_BOX(CLASS,PARENT) \
- class /*BBTK_EXPORT*/ CLASS ## Descriptor : public PARENT ## Descriptor \
+#define BBTK_BEGIN_DESCRIBE_BLACK_BOX_BODY(CLASS) \
{ \
public: typedef CLASS ## Descriptor Self; \
BBTK_OBJECT_MINIMAL_INTERFACE; \
{ \
return Instance(); \
} \
- static bbtk::AtomicBlackBoxDescriptor::Pointer Instance() \
+ static bbtk::AtomicBlackBoxDescriptor::Pointer Instance() \
{ \
- static bbtk::AtomicBlackBoxDescriptor::WeakPointer i; \
- bbtk::AtomicBlackBoxDescriptor::Pointer j; \
+ static bbtk::AtomicBlackBoxDescriptor::WeakPointer i; \
+ bbtk::AtomicBlackBoxDescriptor::Pointer j; \
if (!i.lock()) { j = Self::New(); i = j; } \
return i.lock(); \
} \
<<#CLASS<<"Descriptor()"<<std::endl);
//============================================================================
+//============================================================================
+/// Begins the AtomicBlackBox description block
+#define BBTK_BEGIN_DESCRIBE_BLACK_BOX(CLASS,PARENT) \
+ class /*BBTK_EXPORT*/ CLASS ## Descriptor : public PARENT ## Descriptor \
+ BBTK_BEGIN_DESCRIBE_BLACK_BOX_BODY(CLASS);
+
//============================================================================
/// Ends the AtomicBlackBox description block
#define BBTK_END_DESCRIBE_BLACK_BOX(CLASS) \
(&CLASS<T>::bbSetOutput##NAME) ) )
//============================================================================
+
+//JCP 09JUIN2009 BBTK_EXPORT
+
//============================================================================
/// Template AtomicBlackBox std implementation of ctor and dtor
#define BBTK_BLACK_BOX_TEMPLATE_IMPLEMENTATION(CLASS,PARENT) \
: PARENT(name,false) \
{ \
BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,alloc); \
- CLASS<T>::bbUserConstructor(); \
+ CLASS<T>::bbUserSetDefaultValues(); \
BBTK_END_BLACK_BOX_CONSTRUCTOR(CLASS); \
} \
template <class T> \
: PARENT(from,name,false) \
{ \
BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \
- CLASS<T>::bbUserCopyConstructor(); \
- BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from); \
+ CLASS<T>::bbUserSetDefaultValues(); \
+ BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \
} \
template <class T> \
CLASS<T>::~CLASS() \
{ \
BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \
- CLASS<T>::bbUserDestructor(); \
BBTK_END_BLACK_BOX_DESTRUCTOR(CLASS); \
} \
template <class T> \
: PARENT(name,false) \
{ \
BBTK_BEGIN_BLACK_BOX_CONSTRUCTOR(CLASS,alloc); \
- CLASS<T1,T2>::bbUserConstructor(); \
+ CLASS<T1,T2>::bbUserSetDefaultValues(); \
BBTK_END_BLACK_BOX_CONSTRUCTOR(CLASS); \
} \
template <class T1, class T2> \
: PARENT(from,name,false) \
{ \
BBTK_BEGIN_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \
- CLASS<T1,T2>::bbUserCopyConstructor(); \
- BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from); \
+ CLASS<T1,T2>::bbUserSetDefaultValues(); \
+ BBTK_END_BLACK_BOX_COPY_CONSTRUCTOR(CLASS,from,allocate_connectors); \
} \
template <class T1, class T2> \
CLASS<T1,T2>::~CLASS() \
{ \
BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \
- CLASS<T1,T2>::bbUserDestructor(); \
BBTK_END_BLACK_BOX_DESTRUCTOR(CLASS); \
} \
template <class T1, class T2> \
//============================================================================
-/*
-//============================================================================
-/// Template AtomicBlackBox std implementation of ctor and dtor
-#define BBTK_BLACK_BOX_TEMPLATE2_WITH_TYPES_IMPLEMENTATION(CLASS,PARENT,TYPE1,TYPE2) \
- template <TYPE1 T1, TYPE2 T2> \
- CLASS<T1,T2>::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 <TYPE1 T1, TYPE2 T2> \
- CLASS<T1,T2>::CLASS(CLASS<T1,T2>& 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 <TYPE1 T1, TYPE2 T2> \
- CLASS<T1,T2>::~CLASS() \
- { \
- BBTK_BEGIN_BLACK_BOX_DESTRUCTOR(CLASS); \
- this->bbUserDestructor(); \
- BBTK_END_BLACK_BOX_DESTRUCTOR; \
- } \
- template <class T1, class T2> \
- void CLASS<T1,T2>::bbLockDescriptor() \
- { \
- bbmDescriptorPointer = CLASS ## Descriptor<T1,T2>::Instance(); \
- }
-//============================================================================
-
-*/
-
-
-
-//===========================================================================
-//============================================================================
-// 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<TYPE>(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();*/ }
-//===========================================================================
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff