X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkVirtualExec.h;h=27d3a6edad6249c4fff1ab734a0605a4b1a835d8;hb=03cc68dd6b831aa98e1e0fad20a977ffa074be39;hp=f7c2295446c7fae4f3a556d762f72e6fea3f23fc;hpb=998354bb81a4f450cae3a2263838d7d3b6024bac;p=bbtk.git diff --git a/kernel/src/bbtkVirtualExec.h b/kernel/src/bbtkVirtualExec.h index f7c2295..27d3a6e 100644 --- a/kernel/src/bbtkVirtualExec.h +++ b/kernel/src/bbtkVirtualExec.h @@ -1,20 +1,40 @@ +/* + # --------------------------------------------------------------------- + # + # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image + # pour la SantÈ) + # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton + # Previous Authors : Laurent Guigues, Jean-Pierre Roux + # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil + # + # 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. + # ------------------------------------------------------------------------ */ + + /*========================================================================= - Program: bbtk - Module: $RCSfile: bbtkVirtualExec.h,v $ $ + Module: $RCSfile: bbtkVirtualExec.h,v $ Language: C++ - Date: $Date: 2008/02/05 12:16:56 $ - Version: $Revision: 1.6 $ - - 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: 2012/11/16 08:49:01 $ + Version: $Revision: 1.21 $ =========================================================================*/ + + + /** * \file * \brief class VirtualExec: level 0 of script execution (header) @@ -28,17 +48,18 @@ #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 { @@ -48,6 +69,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& m) = 0; @@ -60,6 +94,17 @@ namespace bbtk /// Sets the mode of dialog of the executer for Root inputs virtual void SetDialogMode(DialogModeType t) = 0; + /// Puts the executer in "no error" mode, + /// Errors do not stop execution (but warnings are produced) + virtual void SetNoErrorMode(bool b) = 0; + virtual bool GetNoErrorMode() const = 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; @@ -71,16 +116,28 @@ 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; + + virtual void SetTypeOfScript_Application( ) = 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; + + /// Clears the currently defined ComplexBlackBox + virtual void Clear() = 0; /// Connects the output boxOutput to the input boxInput virtual void Connect (const std::string &boxfrom, @@ -88,9 +145,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, @@ -125,10 +181,10 @@ namespace bbtk /// The description string which explains what does the ComplexBox virtual void Description(const std::string &d) = 0; - /// prints the list off the boxes of the current box - virtual void PrintBoxes() = 0; + /// prints the list of the boxes of the current box + virtual void PrintHelpListBoxes() = 0; - /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path + /// Generate a HTML file with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path virtual std::string ShowGraph(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr, @@ -140,66 +196,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; + /// Prints help on a black box + virtual void PrintHelpBlackBox(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 mOpenDefinition; - - /// The stack of current working package - /// (is a stack for nested definitions) - 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; - - /// no exec mode flag - bool mNoExecMode; + /// The interpreter which uses it (0 if none) + InterpreterWeakPointer mInterpreter; - /// Dialog mode - DialogModeType mDialogMode; }; } #endif