Forgot this one

[bbtk.git] / kernel / src / bbtkVirtualExec.h

diff --git a/kernel/src/bbtkVirtualExec.h b/kernel/src/bbtkVirtualExec.h
index 1ba529d9f6262bf13997bc83147be6df491a7676..73010f242481c732f1ca237a09115583ccdf104d 100644 (file)
--- a/kernel/src/bbtkVirtualExec.h
+++ b/kernel/src/bbtkVirtualExec.h
@@ -1,20 +1,33 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
-  Module:    $RCSfile: bbtkVirtualExec.h,v $ $
+  Module:    $RCSfile: bbtkVirtualExec.h,v $
   Language:  C++
-  Date:      $Date: 2008/10/02 07:43:21 $
-  Version:   $Revision: 1.16 $
-                                                                                
-  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-  l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-                                                                                
-     This software is distributed WITHOUT ANY WARRANTY; without even
-     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-     PURPOSE.  See the above copyright notices for more information.
-                                                                                
+  Date:      $Date: 2009/06/08 14:50:04 $
+  Version:   $Revision: 1.19 $
 =========================================================================*/
+
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+*  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.
+* ------------------------------------------------------------------------ */                                                                         
+
 /**
  *  \file 
  *  \brief class VirtualExec: level 0 of script execution (header)
@@ -114,6 +127,9 @@ namespace bbtk
     /// Destroys a black box
     virtual void Destroy (const std::string &boxName) = 0;
 
+    /// Clears the currently defined ComplexBlackBox
+    virtual void Clear() = 0;
+
     /// Connects the output boxOutput to the input boxInput
     virtual void Connect (const std::string &boxfrom,
                  const std::string &output,
@@ -156,10 +172,10 @@ namespace bbtk
     /// The description string which explains what does the ComplexBox
     virtual void Description(const std::string &d) = 0;
 
-    /// prints the list off the boxes of the current box
-    virtual void PrintBoxes() = 0;
+    /// prints the list of the boxes of the current box
+    virtual void PrintHelpListBoxes() = 0;
 
-   /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path
+   /// Generate a HTML file with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path
     virtual std::string ShowGraph(const std::string &nameblackbox, 
                          const std::string &detailStr, 
                          const std::string &levelStr,
@@ -171,8 +187,8 @@ namespace bbtk
    /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path
     virtual std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true) = 0;
 
-    /// Description of the actual pipeline
-    virtual void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr) = 0;
+    /// Prints help on a black box
+    virtual void PrintHelpBlackBox(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr) = 0;
     
     virtual void Reset() = 0;