bbtk_creaVtk_PKG/src/bbcreaVtkHttpDataSetReader.xml

   1 <!--
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la SantÈ)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9 #
  10 #  This software is governed by the CeCILL-B license under French law and
  11 #  abiding by the rules of distribution of free software. You can  use,
  12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13 #  license as circulated by CEA, CNRS and INRIA at the following URL
  14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15 #  or in the file LICENSE.txt.
  16 #
  17 #  As a counterpart to the access to the source code and  rights to copy,
  18 #  modify and redistribute granted by the license, users are provided only
  19 #  with a limited warranty  and the software's author,  the holder of the
  20 #  economic rights,  and the successive licensors  have only  limited
  21 #  liability.
  22 #
  23 #  The fact that you are presently reading this means that you have had
  24 #  knowledge of the CeCILL-B license and that you accept its terms.
  25 # ------------------------------------------------------------------------ */
  26 -->
  27
  28 <!--==========================================================================
  29    STARTS THE DESCRIPTION OF THE BLACK BOX -->
  30 <blackbox name="HttpDataSetReader">
  31 <!--=======================================================================-->
  32
  33   <!--========================================================================
  34     THE BOX DOCUMENTATION -->
  35
  36   <author>InfoDev</author>
  37   <description>No Description.  (JavaScript)</description>
  38   <category>empty</category>
  39   <!--=====================================================================-->
  40
  41   <!--========================================================================
  42     #include directives to be put in the .h generated
  43     There must be one tag per file to include
  44     Here we include the standard header iostream.h -->
  45   <include><PRE>iostream</PRE></include>
  46   <include><PRE>vtkImageData.h</PRE></include>
  47   <!--=====================================================================-->
  48
  49   <!--========================================================================
  50     INPUTS/OUTPUTS DECLARATION -->
  51   <!-- Declares an input with name 'In', type 'double'
  52       and description 'First input' -->
  53
  54
  55   <typedef><PRE>typedef std::vector<std::string> OutputTypeVectorString;</PRE></typedef>
  56   <typedef><PRE>typedef std::vector<vtkImageData*> OutputTypeVectorVtkImageData;</PRE></typedef>
  57
  58
  59   <input name="FileNames" type="OutputTypeVectorString" description="First input"/>
  60
  61   <!-- Declares an output with name 'Out', type 'double'
  62       and description 'First output' -->
  63   <output name="Out" type="vtkImageData*" description="Image Output"/>
  64   <output name="OutVector" type="OutputTypeVectorVtkImageData" description="lst of vtkImageData*"/>
  65   <!--=====================================================================-->
  66
  67   <process>
  68   <PRE>
  69 // THE MAIN PROCESSING METHOD BODY
  70 //   Here we simply set the input 'In' value to the output 'Out'
  71 //   And print out the output value
  72 // INPUT/OUTPUT ACCESSORS ARE OF THE FORM :
  73 //    void bbSet{Input|Output}NAME(const TYPE&)
  74 //    const TYPE& bbGet{Input|Output}NAME() const
  75 //    Where :
  76 //    * NAME is the name of the input/output
  77 //      (the one provided in the attribute 'name' of the tag 'input')
  78 //    * TYPE is the C++ type of the input/output
  79 //      (the one provided in the attribute 'type' of the tag 'input')
  80 //    bbSetOutputOut( bbGetInputIn() );
  81 //    std::cout << "Output value = " <<bbGetOutputOut() << std::endl;
  82
  83         printf("EED Warnning!  The implementention of this box just exist in JavaScript\n");
  84
  85   </PRE>
  86   </process>
  87   <!--=====================================================================-->
  88
  89    <defaultValues>
  90   <PRE>
  91 //  SET HERE THE DEFAULT INPUT/OUTPUT VALUES OF YOUR BOX
  92 //    Here we initialize the input 'In' to 0
  93 //   bbSetInputIn(0);
  94   </PRE>
  95   </defaultValues>
  96
  97
  98
  99   <initializeProcessing>
 100   <PRE>
 101 //  THE INITIALIZATION METHOD BODY :
 102 //    Here does nothing
 103 //    but this is where you should allocate the internal/output pointers
 104 //    if any
 105
 106   </PRE>
 107   </initializeProcessing>
 108
 109   <finalizeProcessing>
 110   <PRE>
 111 //  THE FINALIZATION METHOD BODY :
 112 //    Here does nothing
 113 //    but this is where you should desallocate the internal/output pointers
 114 //    if any
 115   </PRE>
 116   </finalizeProcessing>
 117  <!--=====================================================================-->
 118
 119 <!--=======================================================================-->
 120 <!-- END OF BLACK BOX DESCRIPTION -->
 121 </blackbox>
 122 <!--=======================================================================-->