X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkVirtualExec.h;h=cc2d81b547a170aad6b09fa1fd4d66f683d2e0da;hb=4ad5b5ee44357ad873bc8c43230defb6d0a79879;hp=42217a7a1c88b3c53f7fa39121b34da6ab76891c;hpb=2d76cd309d74d5f83d701d6bb0a4140d5d122b36;p=bbtk.git diff --git a/kernel/src/bbtkVirtualExec.h b/kernel/src/bbtkVirtualExec.h index 42217a7..cc2d81b 100644 --- a/kernel/src/bbtkVirtualExec.h +++ b/kernel/src/bbtkVirtualExec.h @@ -3,8 +3,8 @@ Program: bbtk Module: $RCSfile: bbtkVirtualExec.h,v $ $ Language: C++ - Date: $Date: 2008/01/30 09:28:16 $ - Version: $Revision: 1.4 $ + Date: $Date: 2008/04/18 12:59:16 $ + Version: $Revision: 1.12 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -28,36 +28,40 @@ #define __bbtkVirtualExec_h__ #include "bbtkSystem.h" -#include "bbtkComplexBlackBox.h" +#include "bbtkComplexBlackBoxDescriptor.h" #include "bbtkFactory.h" -#include -#include 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 + typedef enum { NoDialog, TextDialog, GraphicalDialog } 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; } -/* - /// Constructor - VirtualExec(); - - /// - // void SetFactory(Factory* f); - - /// Destructor - virtual ~VirtualExec() = 0; -*/ /// Sets the inputs of the workspace : virtual void SetInputs(const std::map& m) = 0; @@ -70,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; @@ -81,16 +92,23 @@ namespace bbtk virtual void Define (const std::string &name, const std::string& pack, const std::string &scriptfilename) = 0; + + /// Sets the file name to use for the current definition + /// (Used to set it after the Define command) + virtual void SetCurrentFileName (const std::string &name ) = 0; /// 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, @@ -98,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, @@ -119,7 +136,7 @@ namespace bbtk const std::string &input, const std::string &value) = 0; - /// gets the output of the box + /// gets the output of the box virtual std::string Get (const std::string &box, const std::string &output) = 0; @@ -129,8 +146,8 @@ namespace bbtk ///Adds the authorName to the Box author list virtual void Author(const std::string &authorName) = 0; - ///Adds the keywords to the Box keywords list - virtual void Keyword(const std::string &keywords) = 0; + ///Adds the categories to the Box categoris list + virtual void Category(const std::string &categories) = 0; /// The description string which explains what does the ComplexBox virtual void Description(const std::string &d) = 0; @@ -147,65 +164,35 @@ namespace bbtk const std::string &custom_title, bool system_display = true) = 0; - /// 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 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; + /// 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 void Reset() = 0; -/* + 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 mCurrent; - - /// flag which is true when we are inside a Define/EndDefine block - // bool mDefineFlag; - - /// The input values of the Root ComplexBlackBox - std::map mInputs; - - /// no exec mode flag - bool mNoExecMode; + /// The interpreter which uses it (0 if none) + InterpreterWeakPointer mInterpreter; - /// Dialog mode - DialogModeType mDialogMode; }; } #endif