kernel/doc/bbtkDoxygen/sequences.txt

   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 /** \page sequences Sequences
  30
  31 \section bbExecute sequence
  32
  33
  34
  35 \arg The user calls bbtk::BlackBox::bbExecute on BlackBox B
  36 \arg bbExecute calls bbtk::BlackBox::bbRecursiveExecute which is the main recursive execution method. It passes a NULL Connection to tell bbRecursiveExecute that the execution order did not come from an output connection.
  37 \arg bbRecursiveExecute does:
  38      - returns if the box is already executing (cycle prevention)
  39      - bbInitializeProcessing : initialize the box if not already done
  40      - Sets the box as executing: bbSetExecuting(true)
  41      - Stores the bool which tells if some other box is executing bbGlobalGetSomeBoxExecuting()
  42      - Sets the global flag which tells if some box is executing ( bbGlobalSetSomeBoxExecuting(true));
  43
  44
  45
  46 */