*** empty log message ***

[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 54aa42743d158a6415622e856c7da190bee7fe86..e40b521e4e5ea2ff39436af44e7a5ed50c3659a8 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml
@@ -5,6 +5,7 @@
 
   <!--========================================================================
     THE BOX DOCUMENTATION -->
+
   <author>__AUTHOR__</author>
   <description>__DESCRIPTION__</description>
   <category>__CATEGORY__</category>
@@ -14,15 +15,14 @@
     #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.h
-  </PRE></include>
+  <include><PRE>iostream</PRE></include>
   <!--=====================================================================-->
 
   <!--========================================================================
     INPUTS/OUTPUTS DECLARATION -->
   <!-- Declares an input with name 'In', type 'double' 
       and description 'First input' -->
+
   <input name="In" type="double" description="First input"/>
   
   <!-- Declares an output with name 'Out', type 'double' 
@@ -30,44 +30,54 @@
   <output name="Out" type="double" description="First output"/>
   <!--=====================================================================-->
 
-  <!--========================================================================
-    THE PROCESSING METHOD BODY :
-    Here simpy copies the value of the input 'In' to the output 'Out'
-    And prints out the 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') -->
-  <process><PRE>
+  <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>
+  </PRE>
+  </process>
   <!--=====================================================================-->
 
-  <!--========================================================================
-    CONSTRUCTORS / DESTRUCTORS (OPTIONAL) 
-    THE CONSTRUCTION METHOD BODY :
-    Here initializes the input 'In' to 0
-    This is also where you should allocate the output pointers -->
-  <constructor><PRE>
-    bbSetInputIn(0);
-  </PRE></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>    
-  <!--=====================================================================-->
+   <defaultValues>
+  <PRE>
+//  SET HERE THE DEFAULT INPUT/OUTPUT VALUES OF YOUR BOX 
+//    Here we initialize the input 'In' to 0
+   bbSetInputIn(0);
+  </PRE>
+  </defaultValues>
+
+
+
+  <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 -->