]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkVtkBlackBoxMacros.h
Add some commented out code (as exemples for newbees)
[bbtk.git] / kernel / src / bbtkVtkBlackBoxMacros.h
index 4fce6738d3826d3717dc7d2c5ab4a41a06d0184d..ce87d7e37c2ccc56472c16322767a65d7283360a 100644 (file)
@@ -1,21 +1,34 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbtkVtkBlackBoxMacros.h,v $
   Language:  C++
-  Date:      $Date: 2008/05/07 06:31:37 $
-  Version:   $Revision: 1.1 $
-                                                                                
-  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: 2009/02/27 11:20:25 $
+  Version:   $Revision: 1.8 $
 =========================================================================*/
 
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+*  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.
+* ------------------------------------------------------------------------ */                                                                         
+
+
 
 /**
  *  \file 
  */
 #ifndef __bbtkVtkBlackBoxMacros_h__
 #define __bbtkVtkBlackBoxMacros_h__
+#include <vtkGarbageCollector.h>
+//#include <vtkObjectFactory.h>
+#include <vtkDebugLeaks.h>
+
 
 //===========================================================================
 //============================================================================
 //===========================================================================
 //===========================================================================
 
+//===========================================================================
+#define BBTK_VTK_DISABLE_GARBAGE_COLLECTOR                             \
+  public:                                                              \
+  virtual void Register(vtkObjectBase* o) {}                           \
+  virtual void UnRegister(vtkObjectBase* o) {}                         \
+  protected:                                                           \
+  virtual void ReportReferences(vtkGarbageCollector* collector) {}
+
+/*
+       
+  public:                                 \
+  virtual void Register(vtkObjectBase* o) {} \
+     {
+     this->RegisterInternal(o, 1);
+     }
+   virtual void UnRegister(vtkObjectBase* o)
+     {
+     this->UnRegisterInternal(o, 1);
+     }
 
+  protected:
+
+   virtual void ReportReferences(vtkGarbageCollector* collector)
+     {
+     // Report references held by this object that may be in a loop.
+     this->Superclass::ReportReferences(collector);
+     vtkGarbageCollectorReport(collector, this->OtherObject, "Other Object");
+     }
+*/
 //===========================================================================
 
-// EED sept 04                                                  \
-//  { return GetInput(); /*PARENT::GetInput();*/ }             \
-//  { PARENT::SetInput( /*(vtkDataObject*)*/ d);                               \
+//===========================================================================
+#define BBTK_VTK_DELETE()                                              \
+  void bbDelete() {                                                    \
+    for (int i=0; i<vtkParent::GetNumberOfInputPorts();++i)            \
+      vtkParent::SetInput(i,0);                                                \
+    bbGetOutputOut()->SetSource(NULL);                                 \
+    /*std::cout << "VTK : bbDelete() "<<std::endl;*/                   \
+    /*std::cout << "Use count = "<<GetUseCount()<<std::endl;*/         \
+    /*std::cout << "VTK count = "<<GetReferenceCount()<<std::endl;*/   \
+    /*    vtkParent::SetReferenceCount(1); GetUseCount());*/           \
+    /*delete this;     */                                              \
+    vtkParent::Delete();                                               \
+  }
 
+//    bbmDescriptorPointer.reset();            
+//===========================================================================
 
+//===========================================================================
+#define BBTK_VTK_NEW(CLASS,VTKPARENT)                                  \
+  inline static Pointer New(const std::string& name)                   \
+  {                                                                    \
+    /*vtkDebugLeaks::ConstructClass(#VTKPARENT);*/                     \
+    bbtkDebugMessage("object",1,"##> "<<#CLASS                         \
+                    <<"::New(\""<<name<<"\")"<<std::endl);             \
+    Pointer p = MakeBlackBoxPointer(new Self(name));                   \
+    bbtkDebugMessage("object",1,"<## "<<#CLASS                         \
+                    <<"::New(\""<<name<<"\")"<<std::endl);             \
+    return p;                                                          \
+  }                                                                    \
+//===========================================================================
 
+//===========================================================================
+#define BBTK_VTK_CLONE(CLASS,VTKPARENT)                                        \
+  inline bbtk::BlackBox::Pointer bbClone(const std::string& name)      \
+  {                                                                    \
+    /*vtkDebugLeaks::ConstructClass(#VTKPARENT);*/                     \
+    bbtkDebugMessage("object",1,"##> "<<#CLASS                         \
+                    <<"::bbClone(\""<<name<<"\")"<<std::endl);         \
+    Pointer p = MakeBlackBoxPointer(new Self(*this,name));             \
+    bbtkDebugMessage("object",1,"<## "<<#CLASS                         \
+                    <<"::bbClone(\""<<name<<"\")"<<std::endl);         \
+    return p;                                                          \
+  }                                                                    
+
+
+//===========================================================================
+#define BBTK_VTK_BLACK_BOX_INTERFACE(CLASS,PARENTBLACKBOX,VTKPARENT)   \
+  BBTK_BLACK_BOX_INTERFACE_WITHOUT_NEW(CLASS,PARENTBLACKBOX);          \
+  typedef VTKPARENT vtkParent;                                         \
+  BBTK_VTK_DELETE();                                                   \
+  public :                                                             \
+  BBTK_VTK_NEW(CLASS,VTKPARENT);                                       \
+  BBTK_VTK_CLONE(CLASS,VTKPARENT);                                     
+
+//  BBTK_VTK_DISABLE_GARBAGE_COLLECTOR
+//===========================================================================
+
+#define BBTK_VTK_UNREGISTER(O) 
+
+//O->UnRegister(this);
+
+//===========================================================================
 /// Declares a vtkImageAlgorithm-inherited AtomicBlackBox input 
-#define BBTK_DECLARE_VTK_IMAGE_ALGORITHM_INPUT(PARENT,NAME,TYPE)                       \
+#define BBTK_DECLARE_VTK_IMAGE_ALGORITHM_INPUT(NAME,TYPE)              \
   public:                                                              \
   TYPE bbGetInput##NAME ()                                             \
-  { return GetImageDataInput(0); /*PARENT::GetInput();*/ }             \
+  { return GetImageDataInput(0); /*vtkParent::GetInput();*/ }          \
   void bbSetInput##NAME (TYPE d)                                       \
-  { PARENT::SetInput( (vtkDataObject*) d);                             \
-    /*bbSetModifiedStatus();*/ }                                                      
+  { vtkParent::SetInput( (vtkDataObject*) d);                          \
+    BBTK_VTK_UNREGISTER(d);/*bbSetModifiedStatus();*/ }                                
+//===========================================================================
+
 //===========================================================================
 /// Declares a vtkPolyDataAlgorithm-inherited AtomicBlackBox input 
-#define BBTK_DECLARE_VTK_POLY_DATA_ALGORITHM_INPUT(PARENT,NAME,TYPE)   \
+#define BBTK_DECLARE_VTK_POLY_DATA_ALGORITHM_INPUT(NAME,TYPE)          \
   public:                                                              \
   TYPE bbGetInput##NAME ()                                             \
-  { return GetPolyDataInput(0); /*PARENT::GetInput();*/ }              \
+  { return GetPolyDataInput(0); /*vtkParent::GetInput();*/ }           \
   void bbSetInput##NAME (TYPE d)                                       \
-  { PARENT::SetInput( (vtkDataObject*) d);                             \
-    /*bbSetModifiedStatus();*/ }                                                      
+  { vtkParent::SetInput( (vtkDataObject*) d);                          \
+    BBTK_VTK_UNREGISTER(d);/*bbSetModifiedStatus();*/ }                                                       
 //===========================================================================
 
 //===========================================================================
 /// Declares a vtkImageAlgorithm-inherited AtomicBlackBox output 
-#define BBTK_DECLARE_VTK_OUTPUT(PARENT,NAME,TYPE)                      \
+#define BBTK_DECLARE_VTK_OUTPUT(NAME,TYPE)                             \
   public:                                                              \
   TYPE bbGetOutput##NAME ()                                            \
-  { return PARENT::GetOutput(); }                                      \
+  { return vtkParent::GetOutput(); }                                   \
   void bbSetOutput##NAME (TYPE d)                                      \
-  { /*PARENT::GetOutput() = d;*/ }                                     
+  { /*vtkParent::GetOutput() = d;*/ }                                  
 //===========================================================================
 
 //===========================================================================
 /// Declares a vtkAlgorithm-inherited AtomicBlackBox input 
-#define BBTK_DECLARE_VTK_INPUT(PARENT,NAME,TYPE)                       \
+#define BBTK_DECLARE_VTK_INPUT(NAME,TYPE)                      \
   public:                                                              \
   TYPE bbGetInput##NAME ()                                             \
-  { return dynamic_cast<TYPE>(PARENT::GetInput()); }                   \
+  { return dynamic_cast<TYPE>(vtkParent::GetInput()); }                        \
   void bbSetInput##NAME (TYPE d)                                       \
-  { PARENT::SetInput( (vtkDataObject*) d); /*PARENT::GetOutput() = d;*/ }
+  { vtkParent::SetInput( (vtkDataObject*) d);                          \
+   BBTK_VTK_UNREGISTER(d);/*vtkParent::GetOutput() = d;*/ }
 
 //===========================================================================
 
 /// 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)                       \
+#define BBTK_DECLARE_VTK_PARAM(NAME,TYPE)                      \
   public:                                                              \
   TYPE bbGetInput##NAME ()                                             \
-  { return PARENT::Get##NAME(); }                                      \
+  { return vtkParent::Get##NAME(); }                                   \
   void bbSetInput##NAME (TYPE d)                                       \
-  { PARENT::Set##NAME(d);                                              \
+  { vtkParent::Set##NAME(d);                                           \
     /*bbSetModifiedStatus();*/ }
 //===========================================================================
 
 
-//===========================================================================
-#define BBTK_VTK_DELETE(VTKPARENT)                             \
-  void bbDelete() {                                            \
-    bbGetOutputOut()->SetSource(NULL);                         \
-    VTKPARENT::Delete(); }
-//===========================================================================
+
+//============================================================================
+/// Defines the default bbUserProcess method for vtk inherited black boxes
+/// (calls vtkParent::Update)
+#define BBTK_VTK_PROCESS()                                             \
+  public:                                                              \
+  inline void bbUserProcess()                                          \
+  {                                                                    \
+    bbtkDebugMessage("process",1,"**> Processing ["<<bbGetFullName()   \
+                    <<"]"<<std::endl);                                 \
+    vtkParent::Update();                                               \
+    bbtkDebugMessage("process",2,"<** Processing ["<<bbGetFullName()   \
+                    <<"]"<<std::endl);                                 \
+  }
+//============================================================================
 
 
 //===========================================================================