]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkVirtualExec.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkVirtualExec.h
index 928a8674708f8eb4a32b4839f147f4e51c5062cc..d09ed5aeb4c6a95f816f21599add33f64e09e45a 100644 (file)
@@ -1,20 +1,33 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
-  Module:    $RCSfile: bbtkVirtualExec.h,v $ $
+  Module:    $RCSfile: bbtkVirtualExec.h,v $
   Language:  C++
-  Date:      $Date: 2008/03/26 14:47:36 $
-  Version:   $Revision: 1.10 $
-                                                                                
-  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: 2008/12/12 12:11:21 $
+  Version:   $Revision: 1.18 $
 =========================================================================*/
+
+/* ---------------------------------------------------------------------
+
+* 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)
 #define __bbtkVirtualExec_h__
 
 #include "bbtkSystem.h"
-//#include "bbtkComplexBlackBox.h"
+#include "bbtkComplexBlackBoxDescriptor.h"
 #include "bbtkFactory.h"
-//#include <string>
-//#include <deque>
 
 namespace bbtk
 {
 
   class Interpreter;
+  BBTK_FORWARD_DECLARE_POINTER(Interpreter);
 
-  class /*BBTK_EXPORT*/ VirtualExec   // All methods are pure virtual
+  class BBTK_EXPORT VirtualExec : public Object
   {
-
+    BBTK_ABSTRACT_OBJECT_INTERFACE(VirtualExec);
   public:
     typedef enum
     {
@@ -50,21 +62,18 @@ namespace bbtk
     }
     DialogModeType;
 
-    VirtualExec() : mInterpreter(0) {}
-
-    virtual ~VirtualExec() {}
 
     /// Sets the interpreter who uses it 
-    void SetInterpreter(Interpreter* i) { mInterpreter = i; }
+    void SetInterpreter(InterpreterPointer i) { mInterpreter = i; }
     /// Gets the interpreter who uses it 
-    Interpreter* GetInterpreter() { return mInterpreter; }
+    InterpreterPointer GetInterpreter(); // { return mInterpreter.lock(); }
     /// Gets the interpreter who uses it (const)
-    const Interpreter* GetInterpreter() const { return mInterpreter; }
+    //    const Interpreter::Pointer GetInterpreter() const { return mInterpreter; }
 
     /// Gets the factory used by the executer
-    virtual Factory* GetFactory() { return 0; }
+    virtual Factory::Pointer GetFactory() { return Factory::Pointer(); }
     /// Gets the factory used by the executer (const)
-    virtual const Factory* GetFactory() const { return 0; }
+    // virtual const Factory* GetFactory() const { return 0; }
     
     /// Sets the inputs of the workspace : 
     virtual void SetInputs(const std::map<std::string,std::string>& m) = 0;
@@ -78,6 +87,10 @@ namespace bbtk
     /// Sets the mode of dialog of the executer for Root inputs 
     virtual void SetDialogMode(DialogModeType t) = 0;
 
+    /// Puts the executer in "no error" mode, 
+    /// Errors do not stop execution (but warnings are produced)
+    virtual void SetNoErrorMode(bool b) = 0;
+    virtual bool GetNoErrorMode() const = 0;
     //=================================================================
    /// Loads a package
     virtual void LoadPackage(const std::string &name ) = 0;
@@ -104,6 +117,9 @@ namespace bbtk
     /// End the definition of a ComplexBlackBox
     virtual void EndDefine () = 0;
 
+    /// Sets the kind of the currently defined ComplexBlackBox
+    virtual void Kind(const std::string& kind) = 0;
+
     /// Creates a new black box in current complex box
     virtual void Create ( const std::string& boxType, const std::string&
     boxName) = 0;
@@ -111,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,
@@ -174,7 +193,7 @@ namespace bbtk
     virtual void Reset() = 0;
     
     /// Sets the level of message for kind
-    virtual void SetMessageLevel(const std::string &kind, int level) = 0,;
+    virtual void SetMessageLevel(const std::string &kind, int level) = 0;
     
     /// Prints help on the messages
     virtual void HelpMessages() = 0;
@@ -182,7 +201,9 @@ namespace bbtk
     /// Prints the string ... MORE : TO EXPLAIN 
     virtual void Print(const std::string & message) = 0;
 
-    
+    virtual ComplexBlackBoxDescriptor::Pointer GetWorkspace() 
+    { return  ComplexBlackBoxDescriptor::Pointer(); }
+  
   //  static const std::string& GetObjectDescription() = 0;
   //  { static std::string s("VirtualExec"); return s; }
   protected:
@@ -190,57 +211,8 @@ namespace bbtk
   private:
 
    /// The interpreter which uses it (0 if none)
-    Interpreter* mInterpreter;
-    /*
-    /// Gets the current working black box 
-    virtual ComplexBlackBoxDescriptor* Current() = 0;
-    
-    /// Returns true when we are inside a define/endefine block
-    //    virtual bool InDefinitionBlock() = 0;
-
-    //==================================================================
-    // ATTRIBUTES
-     
-    /// The factory used
-    //   Factory* mFactory;
-
-    /// The Root Package
-    Package* mPackage;
-    
-    /// The root ComplexBlackBox, in which operations are done when outside a define/endefine block
-    /// Its name in bbi is 'workspace'  
-    ComplexBlackBoxDescriptor* mRoot;
-
-    /// Struct that stores info on user defined complex black boxes
-    struct CBBDefinition
-    {
-      ComplexBlackBoxDescriptor* box;
-      std::string package;
-      CBBDefinition(ComplexBlackBoxDescriptor* d, const std::string& p )
-        : box(d), package(p) {}
-    };
-
-    /// The stack of current working ComplexBlackBox
-    /// (is a stack for nested definitions)
-    /// only contains the root when outside a define/endefine block
-    std::deque<CBBDefinition> mOpenDefinition;
-
-   /// The stack of current working package
-    /// (is a stack for nested definitions)
-    std::deque<Package*> mOpenPackage;
-
-    /// flag which is true when we are inside a Define/EndDefine block
-    //    bool mDefineFlag;
-    
-    /// The input values of the Root ComplexBlackBox
-    std::map<std::string,std::string> mInputs;
-    
-    /// no exec mode flag
-    bool mNoExecMode;
+    InterpreterWeakPointer mInterpreter;
 
-    /// Dialog mode
-    DialogModeType mDialogMode;
-    */
   };
 }
 #endif