kernel/appli/bbCreateBlackBox/xml-templates/std-template.xml

   1 <!--==========================================================================
   2    STARTS THE DESCRIPTION OF THE BLACK BOX -->
   3 <blackbox name="__BLACKBOXNAME__">
   4 <!--=======================================================================-->
   5
   6   <!--========================================================================
   7     THE BOX DOCUMENTATION -->
   8
   9   <author>__AUTHOR__</author>
  10   <description>__DESCRIPTION__</description>
  11   <category>__CATEGORY__</category>
  12   <!--=====================================================================-->
  13
  14   <!--========================================================================
  15     #include directives to be put in the .h generated
  16     There must be one tag per file to include
  17     Here we include the standard header iostream.h -->
  18   <include><PRE>iostream</PRE></include>
  19   <!--=====================================================================-->
  20
  21   <!--========================================================================
  22     INPUTS/OUTPUTS DECLARATION -->
  23   <!-- Declares an input with name 'In', type 'double'
  24       and description 'First input' -->
  25
  26   <input name="In" type="double" description="First input"/>
  27
  28   <!-- Declares an output with name 'Out', type 'double'
  29       and description 'First output' -->
  30   <output name="Out" type="double" description="First output"/>
  31   <!--=====================================================================-->
  32
  33   <!--========================================================================
  34     THE PROCESSING METHOD BODY :
  35     Here simpy copies the value of the input 'In' to the output 'Out'
  36     And prints out the value
  37     INPUT/OUTPUT ACCESSORS ARE OF THE FORM :
  38       void bbSet{Input|Output}NAME(const TYPE&)
  39       const TYPE& bbGet{Input|Output}NAME() const
  40     Where :
  41     * NAME is the name of the input/output
  42       (the one provided in the attribute 'name' of the tag 'input')
  43     * TYPE is the C++ type of the input/output
  44       (the one provided in the attribute 'type' of the tag 'input') -->
  45
  46   <process><PRE>
  47     bbSetOutputOut( bbGetInputIn() );
  48     std::cout << "Output value = " <<bbGetOutputOut() << std::endl;
  49   </PRE></process>
  50   <!--=====================================================================-->
  51
  52   <!--========================================================================
  53     CONSTRUCTORS / DESTRUCTORS (OPTIONAL)
  54     THE CONSTRUCTION METHOD BODY :
  55     Here initializes the input 'In' to 0
  56     This is also where you should allocate the output pointers -->
  57   <constructor><PRE>
  58     bbSetInputIn(0);
  59   </PRE></constructor>
  60
  61   <!-- THE COPY-CONSTRUCTION METHOD BODY :
  62     Here does nothing
  63     But this is where you should allocate the output pointers if any
  64     and copy the pointed values (to avoid bug caused by multiple references)-->
  65   <copyconstructor><PRE>
  66   </PRE></copyconstructor>
  67
  68   <!-- THE DESTRUCTION METHOD BODY :
  69     Here does nothing
  70     but this is where you should desallocate the output pointers if any -->
  71   <destructor><PRE>
  72   </PRE></destructor>
  73   <!--=====================================================================-->
  74
  75 <!--=======================================================================-->
  76 <!-- END OF BLACK BOX DESCRIPTION -->
  77 </blackbox>
  78 <!--=======================================================================-->