]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkVirtualExec.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkVirtualExec.h
index 96a264b55a8f3fbd0231ae163dcb5be5254f885b..ea62f2385af33900f2fcc87c53b7f9af0121803a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkVirtualExec.h,v $ $
   Language:  C++
-  Date:      $Date: 2008/02/06 09:27:52 $
-  Version:   $Revision: 1.7 $
+  Date:      $Date: 2008/04/22 06:59:31 $
+  Version:   $Revision: 1.13 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #define __bbtkVirtualExec_h__
 
 #include "bbtkSystem.h"
-#include "bbtkComplexBlackBox.h"
+#include "bbtkComplexBlackBoxDescriptor.h"
 #include "bbtkFactory.h"
-#include <string>
-#include <deque>
 
 namespace bbtk
 {
 
-  class /*BBTK_EXPORT*/ VirtualExec   // All methods are pure virtual
-  {
+  class Interpreter;
+  BBTK_FORWARD_DECLARE_POINTER(Interpreter);
 
+  class /*BBTK_EXPORT*/ VirtualExec : public Object
+  {
+    BBTK_ABSTRACT_OBJECT_INTERFACE(VirtualExec);
   public:
     typedef enum
     {
@@ -48,6 +49,19 @@ namespace bbtk
     }
     DialogModeType;
 
+
+    /// Sets the interpreter who uses it 
+    void SetInterpreter(InterpreterPointer i) { mInterpreter = i; }
+    /// Gets the interpreter who uses it 
+    InterpreterPointer GetInterpreter(); // { return mInterpreter.lock(); }
+    /// Gets the interpreter who uses it (const)
+    //    const Interpreter::Pointer GetInterpreter() const { return mInterpreter; }
+
+    /// Gets the factory used by the executer
+    virtual Factory::Pointer GetFactory() { return Factory::Pointer(); }
+    /// Gets the factory used by the executer (const)
+    // 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;
 
@@ -60,6 +74,13 @@ namespace bbtk
     /// Sets the mode of dialog of the executer for Root inputs 
     virtual void SetDialogMode(DialogModeType t) = 0;
 
+    //=================================================================
+   /// Loads a package
+    virtual void LoadPackage(const std::string &name ) = 0;
+
+    /// Unloads a package
+    virtual void UnLoadPackage(const std::string &name ) = 0;
+
     /// Starts a package block 
     virtual void BeginPackage (const std::string &name ) = 0;
 
@@ -79,12 +100,15 @@ 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;
 
     /// Destroys a black box
-    //virtual void Destroy (const std::string &boxName) = 0;
+    virtual void Destroy (const std::string &boxName) = 0;
 
     /// Connects the output boxOutput to the input boxInput
     virtual void Connect (const std::string &boxfrom,
@@ -92,9 +116,8 @@ namespace bbtk
                  const std::string &boxto,
                  const std::string &input) = 0;
 
-    /// Updates the box 
-    /// would 'Execute' be more meaningfull ?
-    virtual void Update (const std::string &box) = 0;
+    /// Executes the box 
+    virtual void Execute (const std::string &box) = 0;
 
     /// Defines an input of the current complex box
     virtual void DefineInput (const std::string &name,
@@ -144,66 +167,32 @@ 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;
-
-       virtual void Reset() = 0;
+    /// Description of the actual pipeline
+    virtual void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr) = 0;
+    
+    virtual void Reset() = 0;
+    
+    /// Sets the level of message for kind
+    virtual void SetMessageLevel(const std::string &kind, int level) = 0,;
+    
+    /// Prints help on the messages
+    virtual void HelpMessages() = 0;
 
+    /// 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:
 
   private:
 
-    /// 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;
+   /// The interpreter which uses it (0 if none)
+    InterpreterWeakPointer mInterpreter;
 
-    /// Dialog mode
-    DialogModeType mDialogMode;
   };
 }
 #endif