]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkTranscriptor.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkTranscriptor.h
index 5ab590a956df924e2fbb9414be54f324ca0c3b6b..35d02e05e20b938ddce7b940d00bf7478af2d68d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkTranscriptor.h,v $ $
   Language:  C++
-  Date:      $Date: 2008/01/22 17:00:17 $
-  Version:   $Revision: 1.1 $
+  Date:      $Date: 2008/04/18 12:59:16 $
+  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
  */
  
 #ifndef __bbtkTranscriptor_h__
-#define __bbtkTranscriptor_h__ 
+#define __bbtkTranscriptor_h__
 
 #include "bbtkVirtualExec.h"
 
+#include "bbtkSystem.h"
 #include <iostream>
 
 namespace bbtk
@@ -36,15 +37,12 @@ namespace bbtk
 
   class /*BBTK_EXPORT*/ Transcriptor : public VirtualExec
   {
+    BBTK_OBJECT_INTERFACE(Transcriptor);
+    typedef VirtualExec Superclass;
+  public:
+    static Pointer New(const std::string& filename);
 
-  public:  
-
-    /// Constructor
-    Transcriptor(std::string filename);
-      
-    /// Destructor
-    ~Transcriptor( );
-    
+   
     /// Sets the inputs of the workspace : 
     void SetInputs(const std::map<std::string,std::string>& m) { mInputs = m; }
 
@@ -54,29 +52,45 @@ namespace bbtk
     //void SetNoExecMode(bool b) { mNoExecMode = b; }
     void SetNoExecMode(bool b)
     {
-       m_Fp << "e->SetNoExecMode(true);" << std::endl;      
-    }    
+       if (b)
+          m_Fp << "  e->SetNoExecMode(true);" << std::endl;
+       else
+          m_Fp << "  e->SetNoExecMode(false);" << std::endl;       
+    }
 
     bool GetNoExecMode() const { return mNoExecMode; }
-    /*
-    bool GetNoExecMode() const 
-    {
-      // cannot compile, since ethos is 'const' !
-      //m_Fp << "e->GetNoExecMode(true);" << std::endl;      
-    }
-    */
+
     /// Sets the mode of dialog of the executer for Root inputs 
     void SetDialogMode(DialogModeType t) { mDialogMode = t; }
 
+    /// Loads a package
+    void LoadPackage(const std::string &name );
+
+    /// Unloads a package
+    void UnLoadPackage(const std::string &name );
+
+    /// Starts a package block 
+    void BeginPackage (const std::string &name );
+
+    /// Ends a package block
+    void EndPackage ();
+
     /// Starts the definition of a new ComplexBlackBox in package pack
     /// scriptfilename is the file from which the def is read
     void Define (const std::string &name,
                 const std::string& pack,
                 const std::string &scriptfilename);
 
+    /// Sets the file name to use for the current definition
+    /// (Used to set it after the Define command)
+    void SetCurrentFileName (const std::string &name );
+
     /// End the definition of a ComplexBlackBox
     void EndDefine ();
 
+    /// Sets the kind of the currently defined ComplexBlackBox
+    void Kind(const std::string& kind);
+
     /// Creates a new black box in current complex box
     void Create ( const std::string& boxType, const std::string& boxName);
 
@@ -90,8 +104,7 @@ namespace bbtk
                  const std::string &input);
 
     /// Updates the box 
-    /// would 'Execute' be more meaningfull ?
-    void Update (const std::string &box);
+    void Execute(const std::string &box);
 
     /// Defines an input of the current complex box
     void DefineInput (const std::string &name,
@@ -117,9 +130,12 @@ namespace bbtk
     /// changes the workspace name
     void SetWorkspaceName( const std::string& n );
 
-    ///Adds the authorName to the Box's author list
+    ///Adds the authorName to the Box author list
     void Author(const std::string &authorName);
 
+    ///Adds the Categories to the Box category list
+    void Category(const std::string &category);
+
     /// The description string which explains what does the ComplexBox
     void Description(const std::string & d);
 
@@ -142,50 +158,26 @@ namespace bbtk
       void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr);
 
       void Reset();
+  /// Sets the level of message for kind
+    void SetMessageLevel(const std::string &kind,
+                         int level);
+
+   /// Prints help on the messages
+    void HelpMessages();
+    
+    /// Prints the string ... MORE : TO EXPLAIN 
+    void Print(const std::string & message);
 
-  //  static const std::string& GetObjectDescription() 
+  //  static const std::string& GetObjectDescription()
   //  { static std::string s("Executer"); return s; }
 
   protected:
 
   private:
+    /// Constructor
+    Transcriptor(const std::string& filename);
 
-    /// Gets the current working black box 
-    ComplexBlackBoxDescriptor* Current() { return mCurrent.back().box; }
-    
-    /// Returns true when we are inside a define/endefine block
-    //    bool InDefinitionBlock() { return (mCurrent.size()>1); }
-
-    //==================================================================
-    // 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> mCurrent;
-
-    /// 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;
     
@@ -196,8 +188,8 @@ namespace bbtk
     DialogModeType mDialogMode;
     
     /// File Pointer, to hold generated C++ code.
-   // std::ofstream *m_Fp;
-   std::ofstream m_Fp;
+    // std::ofstream *m_Fp;
+    std::ofstream m_Fp;
   };
 }
 #endif