#2969 BBTK Bug New Normal - MesureLength box in vtk package

[bbtk.git] / kernel / appli / bbCreateBlackBox / xml-templates / VTK_PolyDataAlgorithm-template.xml

diff --git a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
index b6eca380de057af593c2c50bef74e799c915a70e..d491ddff9ce6a6e4078876c85ec263bf265cde8e 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
@@ -1,15 +1,54 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-
+<!--
+ # ---------------------------------------------------------------------
+ #
+ # 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.
+ # ------------------------------------------------------------------------ */
+ -->
 
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--==========================================================================
+   STARTS THE DESCRIPTION OF THE BLACK BOX -->
 <blackbox name="__BLACKBOXNAME__" type="VTK_PolyDataAlgorithm">
 
+ <!--========================================================================
+    THE BOX DOCUMENTATION -->
+
 <author>__AUTHOR__</author>
 <description><PRE>__DESCRIPTION__</PRE></description>
 <category>__CategoryBlackBox__</category>
 
+<!--========================================================================
+    #include directives to be put in the .h generated
+    There must be one tag per file to include -->
+
 <include>vtkAppendPolyData.h</include> 
+
+  <!--========================================================================
+    THE vtk class the box inherits from (if any) -->
 <vtkparent>vtkAppendPolyData</vtkparent>
 
+ <!--========================================================================
+    INPUTS/OUTPUTS DECLARATION -->
 <output name="Out" type="vtkPolyData*" special="vtk output" description="Output Mesh"/>
 <input name="In1" type="vtkPolyData *" description="PolyData 1"/>
 <input name="In2" type="vtkPolyData *" description="PolyData 2"/>
@@ -17,18 +56,23 @@
 <input name="In4" type="vtkPolyData *" description="PolyData 4"/>
 <input name="In5" type="vtkPolyData *" description="PolyData 5"/>
 
+ <!--========================================================================
+    PROCESS section -->
+
 <process>
 <PRE>
-  SetInput(bbGetInputIn1());
-  SetInput(bbGetInputIn2());
-  SetInput(bbGetInputIn3());
-  SetInput(bbGetInputIn4());
-  SetInput(bbGetInputIn5());
-   
+  bbSetOutput((vtkPolyData *)0);
+
   Update();
 </PRE>
 </process>
 
+  <!--========================================================================
+    CONSTRUCTORS / DESTRUCTORS (OPTIONAL) 
+    THE CONSTRUCTION METHOD BODY :
+    Generaly you initialize the Input variables with their default values
+    This is also where you should allocate the output pointers -->
+
 <constructor>
 <PRE>
   bbSetInputIn1((vtkPolyData *)0);
@@ -38,9 +82,29 @@
   bbSetInputIn5((vtkPolyData *)0);
   bbSetOutputOut((vtkPolyData *)0);
 </PRE>
-</constructor>   
+</constructor>
+
+  <!-- THE COPY-CONSTRUCTION METHOD BODY :
+    Here does nothing 
+    But this is where you should allocate the output pointers if any
+    and copy the pointed values (to avoid bug caused by multiple references)-->
+  <copyconstructor>
+  <PRE>
+  </PRE>
+  </copyconstructor>
+
+  <!-- THE DESTRUCTION METHOD BODY :
+    Here does nothing 
+    but this is where you should desallocate the output pointers if any -->
+
+  <destructor>
+  <PRE>
 
+  </PRE>
+  </destructor>
 
+<!--=======================================================================-->
+<!-- END OF BLACK BOX DESCRIPTION -->
 </blackbox>