X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkExecuter.h;h=71f92d227b10fe8960e0836f7240d8e603d6af18;hb=1688b52778caa9985ecea38aad38341817e0401a;hp=5f8b8a4ff25ed2dda5b7a74e78ee68a2bcdbb89d;hpb=6c5d7746e8e4cb0b5d6e164b917008a7137910fb;p=bbtk.git diff --git a/kernel/src/bbtkExecuter.h b/kernel/src/bbtkExecuter.h index 5f8b8a4..71f92d2 100644 --- a/kernel/src/bbtkExecuter.h +++ b/kernel/src/bbtkExecuter.h @@ -1,20 +1,33 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk - Module: $RCSfile: bbtkExecuter.h,v $ $ + Module: $RCSfile: bbtkExecuter.h,v $ Language: C++ - Date: $Date: 2008/04/08 06:59:30 $ - 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 - 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: 2009/06/08 14:50:03 $ + Version: $Revision: 1.18 $ =========================================================================*/ + +/* --------------------------------------------------------------------- + +* 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 Executer: level 0 of script execution (header) @@ -43,19 +56,16 @@ namespace bbtk class /*BBTK_EXPORT*/ Executer : public VirtualExec { - + BBTK_OBJECT_INTERFACE(Executer); + typedef VirtualExec Superclass; public: - - /// Constructor - Executer(); - /// Destructor - ~Executer(); + static Pointer New(); /// Gets the factory used by the executer - Factory* GetFactory() { return mFactory; } + Factory::Pointer GetFactory() { return mFactory; } /// Gets the factory used by the executer (const) - const Factory* GetFactory() const { return mFactory; } + // const Factory::Pointer GetFactory() const { return mFactory; } /// Sets the inputs of the workspace : @@ -70,6 +80,9 @@ namespace bbtk /// Sets the mode of dialog of the executer for Root inputs void SetDialogMode(DialogModeType t) { mDialogMode = t; } + void SetNoErrorMode(bool b) { mNoErrorMode = b; } + + bool GetNoErrorMode() const { return mNoErrorMode; } //================================================================= @@ -107,6 +120,9 @@ namespace bbtk /// 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, @@ -149,8 +165,13 @@ namespace bbtk /// The description string which explains what does the ComplexBox void Description(const std::string & d); + + + + + /// prints the list off the boxes of the current box - void PrintBoxes(); + void PrintHelpListBoxes(); /// 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, @@ -164,9 +185,14 @@ namespace bbtk /// 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); + /// Prints help on a black box + void PrintHelpBlackBox(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + + + + + /// Resets the workspace : destroys all boxes / unloads all packages void Reset(); @@ -183,13 +209,21 @@ namespace bbtk // 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); } @@ -198,26 +232,27 @@ namespace bbtk // ATTRIBUTES /// The factory used - Factory* mFactory; + Factory::Pointer mFactory; /// The Root Package /// Contains the root ComplexBlabkBox /// In which ComplexBlackBoxes are put by default /// Its name in bbi is 'user' - Package* mRootPackage; + Package::WeakPointer mRootPackage; /// The root ComplexBlackBox /// in which operations are done when outside a define/endefine block /// Its name in bbi is 'workspace' - ComplexBlackBoxDescriptor* mRootCBB; + 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) {} }; @@ -228,7 +263,7 @@ namespace bbtk /// The stack of current working package /// (is a stack for nested definitions) - std::deque mOpenPackage; + std::deque mOpenPackage; /// The input values of the Root ComplexBlackBox std::map mInputs; @@ -236,8 +271,13 @@ namespace bbtk /// no exec mode flag bool mNoExecMode; + /// Dialog mode DialogModeType mDialogMode; + + /// no error mode flag + bool mNoErrorMode; + }; } #endif