]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkTranscriptor.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkTranscriptor.h
index 97eeb56f15bfd7aa1320b6f0b389e7a9e866f968..dba498ba9f91b2e4d3673b1e35141de8efa2d491 100644 (file)
@@ -1,20 +1,33 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
-  Module:    $RCSfile: bbtkTranscriptor.h,v $ $
+  Module:    $RCSfile: bbtkTranscriptor.h,v $
   Language:  C++
-  Date:      $Date: 2008/02/14 20:23:51 $
-  Version:   $Revision: 1.5 $
-                                                                                
-  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.13 $
 =========================================================================*/
+
+/* ---------------------------------------------------------------------
+
+* 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 Transcriptor: level 0 of script C++ translation (header)
 #include "bbtkVirtualExec.h"
 
 #include "bbtkSystem.h"
-#include "bbtkComplexBlackBox.h"
-#include "bbtkFactory.h"
-#include <string>
-#include <deque>
 #include <iostream>
 
 namespace bbtk
@@ -41,15 +50,12 @@ namespace bbtk
 
   class /*BBTK_EXPORT*/ Transcriptor : public VirtualExec
   {
-
+    BBTK_OBJECT_INTERFACE(Transcriptor);
+    typedef VirtualExec Superclass;
   public:
+    static Pointer New(const std::string& filename);
 
-    /// 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; }
 
@@ -65,17 +71,26 @@ namespace bbtk
           m_Fp << "  e->SetNoExecMode(false);" << std::endl;       
     }
 
-    bool GetNoExecMode() const { return mNoExecMode; }
-    /*
-    bool GetNoExecMode() const
+    void SetNoErrorMode(bool b)
     {
-      // cannot compile, since ethos is 'const' !
-      //m_Fp << "e->GetNoExecMode(true);" << std::endl;
+       if (b)
+          m_Fp << "  e->SetNoErrorMode(true);" << std::endl;
+       else
+          m_Fp << "  e->SetNoErrorMode(false);" << std::endl;       
     }
-    */
+
+    bool GetNoExecMode() const { return false; }
+    bool GetNoErrorMode() const { return false; }
+
     /// 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 );
 
@@ -95,12 +110,18 @@ namespace bbtk
     /// 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);
 
     /// Destroys a black box
     void Destroy (const std::string &boxName);
 
+    /// Clears the currently defined ComplexBlackBox
+    void Clear();
+
     /// Connects the output boxOutput to the input boxInput
     void Connect (const std::string &boxfrom,
                  const std::string &output,
@@ -108,8 +129,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,
@@ -163,6 +183,16 @@ 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 std::string s("Executer"); return s; }
@@ -170,54 +200,12 @@ namespace bbtk
   protected:
 
   private:
+    /// Constructor
+    Transcriptor(const std::string& filename);
 
-    /// Gets the current working black box 
-    ComplexBlackBoxDescriptor* Current() 
-       { return mOpenDefinition.back().box; }
-    
-    /// Returns true when we are inside a define/endefine block
-    //    bool InDefinitionBlock() { return (mOpenDefinition.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> 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;
-
     /// Dialog mode
     DialogModeType mDialogMode;