X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkExecuter.h;h=fc177e254bccff63993aab000714051de0cebccc;hb=5d503ab0e50fbae3cd2ebd26e6c815557abbe42e;hp=bcd8b246ae8197d3c0de782a36039614bad3366b;hpb=aefd641287e852b80d22c3cddd8b2025f12cb1d6;p=bbtk.git diff --git a/kernel/src/bbtkExecuter.h b/kernel/src/bbtkExecuter.h index bcd8b24..fc177e2 100644 --- a/kernel/src/bbtkExecuter.h +++ b/kernel/src/bbtkExecuter.h @@ -3,8 +3,8 @@ Program: bbtk Module: $RCSfile: bbtkExecuter.h,v $ $ Language: C++ - Date: $Date: 2008/02/06 09:27:52 $ - Version: $Revision: 1.7 $ + Date: $Date: 2008/04/22 09:40:10 $ + Version: $Revision: 1.14 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -38,20 +38,23 @@ namespace bbtk { + class Interpreter; + + class /*BBTK_EXPORT*/ Executer : public VirtualExec { - + BBTK_OBJECT_INTERFACE(Executer); + typedef VirtualExec Superclass; public: + static Pointer New(); + + + /// Gets the factory used by the executer + Factory::Pointer GetFactory() { return mFactory; } + /// Gets the factory used by the executer (const) + // const Factory::Pointer GetFactory() const { return mFactory; } - /// Constructor - Executer(); - /// - // void SetFactory(Factory* f); - - /// Destructor - ~Executer(); - /// Sets the inputs of the workspace : void SetInputs(const std::map& m) { mInputs = m; } @@ -64,6 +67,15 @@ namespace bbtk /// 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 ); @@ -79,10 +91,13 @@ namespace bbtk /// 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); @@ -95,9 +110,8 @@ namespace bbtk const std::string &boxto, const std::string &input); - /// Updates the box - /// would 'Execute' be more meaningfull ? - void Update (const std::string &box); + /// Executes the box + void Execute (const std::string &box); /// Defines an input of the current complex box void DefineInput (const std::string &name, @@ -110,7 +124,7 @@ namespace bbtk const std::string &box, const std::string &output, const std::string &help); - + /// sets the input of the box with the value void Set (const std::string &box, const std::string &input, @@ -135,7 +149,7 @@ namespace bbtk /// prints the list off the boxes of the current box void PrintBoxes(); - /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path + /// Generate a HTML with a gif file with the current pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraph(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr, @@ -144,24 +158,43 @@ namespace bbtk const std::string &custom_title, bool system_display = true); - /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path + /// Generate a HTML with a gif file with the current pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true); + + /// Description of the actual pipeline + void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + + /// Resets the workspace : destroys all boxes / unloads all packages + void Reset(); - /// Description of the actual pipeline - void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + /// Sets the level of message for kind + void SetMessageLevel(const std::string &kind, + int level); + + /// Prints help on the messages + void HelpMessages(); + - void Reset(); + void Print(const std::string & message); // static const std::string& GetObjectDescription(); // { static std::string s("Executer"); return s; } + + ComplexBlackBoxDescriptor::Pointer GetWorkspace() + { return mRootCBB.lock(); } + Package::Pointer GetUserPackage() + { return mRootPackage.lock(); } + + /// Gets the current working black box + ComplexBlackBoxDescriptor::Pointer GetCurrentDescriptor() + { return mOpenDefinition.back().box; } + + protected: private: - /// 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); } @@ -170,36 +203,39 @@ namespace bbtk // ATTRIBUTES /// The factory used - // Factory* mFactory; - - /// The Root Package - Package* mPackage; + Factory::Pointer mFactory; - /// The root ComplexBlackBox, in which operations are done when outside a define/endefine block + + /// The Root Package + /// Contains the root ComplexBlabkBox + /// In which ComplexBlackBoxes are put by default + /// Its name in bbi is 'user' + Package::WeakPointer mRootPackage; + + /// The root ComplexBlackBox + /// in which operations are done when outside a define/endefine block /// Its name in bbi is 'workspace' - ComplexBlackBoxDescriptor* mRoot; + ComplexBlackBoxDescriptor::WeakPointer mRootCBB; /// Struct that stores info on user defined complex black boxes struct CBBDefinition { - ComplexBlackBoxDescriptor* box; + ComplexBlackBoxDescriptor::Pointer box; std::string package; - CBBDefinition(ComplexBlackBoxDescriptor* d, const std::string& p ) + CBBDefinition(ComplexBlackBoxDescriptor::Pointer 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 + /// only contains the root cbb when outside a define/endefine block std::deque mOpenDefinition; /// The stack of current working package /// (is a stack for nested definitions) - std::deque mOpenPackage; + std::deque mOpenPackage; - /// flag which is true when we are inside a Define/EndDefine block - // bool mDefineFlag; - /// The input values of the Root ComplexBlackBox std::map mInputs;