Feature #1774

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

diff --git a/kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml b/kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml
index 70e19b1c41e3efa504e9e260cb8ac8b5f03143b9..924e6c5fb8e9bf84b06f6b27de11c9297a246134 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml
@@ -1,24 +1,112 @@
-<?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.
+# ------------------------------------------------------------------------ */
+-->
 
+<!--==========================================================================
+   STARTS THE DESCRIPTION OF THE BLACK BOX -->
 <blackbox name="__BLACKBOXNAME__">
+<!--=======================================================================-->
+
+  <!--========================================================================
+    THE BOX DOCUMENTATION -->
 
   <author>__AUTHOR__</author>
   <description>__DESCRIPTION__</description>
-  <category>__CategoryBlackBox__</category>
+  <category>__CATEGORY__</category>
+  <!--=====================================================================-->
+
+  <!--========================================================================
+    #include directives to be put in the .h generated
+    There must be one tag per file to include
+    Here we include the standard header iostream.h -->
+  <include><PRE>iostream</PRE></include>
+  <!--=====================================================================-->
 
-  <input name="In1" type="double" description="First number to add"/>
-  <input name="In2" type="double" description="Second number to add"/>
-  <output name="Out" type="double" description="Result"/>
+  <!--========================================================================
+    INPUTS/OUTPUTS DECLARATION -->
+  <!-- Declares an input with name 'In', type 'double' 
+      and description 'First input' -->
 
-  <process><PRE>
-    bbSetOutputOut( bbGetInputIn1() + bbGetInputIn2() );
-  </PRE></process>
+  <input name="In" type="double" description="First input"/>
   
-  <constructor><PRE>
-    bbSetInputIn1(0);
-    bbSetInputIn2(0);
-    bbSetOutputOut(0);
-  </PRE></constructor>    
+  <!-- Declares an output with name 'Out', type 'double' 
+      and description 'First output' -->
+  <output name="Out" type="double" description="First output"/>
+  <!--=====================================================================-->
+
+  <process>
+  <PRE>
+// THE MAIN PROCESSING METHOD BODY
+//   Here we simply set the input 'In' value to the output 'Out'
+//   And print out the output value
+// INPUT/OUTPUT ACCESSORS ARE OF THE FORM :
+//    void bbSet{Input|Output}NAME(const TYPE&)
+//    const TYPE& bbGet{Input|Output}NAME() const 
+//    Where :
+//    * NAME is the name of the input/output
+//      (the one provided in the attribute 'name' of the tag 'input')
+//    * TYPE is the C++ type of the input/output
+//      (the one provided in the attribute 'type' of the tag 'input')
+    bbSetOutputOut( bbGetInputIn() );
+    std::cout << "Output value = " <<bbGetOutputOut() << std::endl;
+  </PRE>
+  </process>
+  <!--=====================================================================-->
+
+   <defaultValues>
+  <PRE>
+//  SET HERE THE DEFAULT INPUT/OUTPUT VALUES OF YOUR BOX 
+//    Here we initialize the input 'In' to 0
+   bbSetInputIn(0);
+  </PRE>
+  </defaultValues>
 
-</blackbox>
 
+
+  <initializeProcessing>
+  <PRE>
+//  THE INITIALIZATION METHOD BODY :
+//    Here does nothing 
+//    but this is where you should allocate the internal/output pointers 
+//    if any 
+
+  </PRE>
+  </initializeProcessing>
+
+  <finalizeProcessing>
+  <PRE>
+//  THE FINALIZATION METHOD BODY :
+//    Here does nothing 
+//    but this is where you should desallocate the internal/output pointers 
+//    if any
+  </PRE>
+  </finalizeProcessing>
+ <!--=====================================================================-->
+
+<!--=======================================================================-->
+<!-- END OF BLACK BOX DESCRIPTION -->
+</blackbox>
+<!--=======================================================================-->