X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkComplexBlackBoxDescriptor.h;h=f9e7f8d8997e61525dc933c96aa4e6b280f8df58;hb=4634377e45465b15485afc9da74a5bf13b32d17b;hp=4b76df5cef0d371f21b7806cc7f8433849246262;hpb=6c5d7746e8e4cb0b5d6e164b917008a7137910fb;p=bbtk.git diff --git a/kernel/src/bbtkComplexBlackBoxDescriptor.h b/kernel/src/bbtkComplexBlackBoxDescriptor.h index 4b76df5..f9e7f8d 100644 --- a/kernel/src/bbtkComplexBlackBoxDescriptor.h +++ b/kernel/src/bbtkComplexBlackBoxDescriptor.h @@ -1,21 +1,39 @@ +/* + # --------------------------------------------------------------------- + # + # 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: bbtkComplexBlackBoxDescriptor.h,v $ Language: C++ - Date: $Date: 2008/04/08 06:59:30 $ - Version: $Revision: 1.3 $ - - 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.8 $ =========================================================================*/ + /** * \file * \brief Class bbtk::ComplexBlackBoxDescriptor : describes a ComplexBlackBox (constituents, connections) and is able to create an instance of it. @@ -33,37 +51,47 @@ #include "bbtkComplexBlackBoxOutputDescriptor.h" #include "bbtkFactory.h" #include - +#include +#include "bbtkUtilities.h" namespace bbtk { class ComplexBlackBox; - + typedef boost::shared_ptr ComplexBlackBoxPointer; + //========================================================================== - class BBTK_EXPORT ComplexBlackBoxDescriptor : public bbtk::BlackBoxDescriptor + class BBTK_EXPORT ComplexBlackBoxDescriptor : + public bbtk::BlackBoxDescriptor { + BBTK_OBJECT_INTERFACE(ComplexBlackBoxDescriptor); + typedef BlackBoxDescriptor Superclass; public: friend class ComplexBlackBox; - /// Default ctor with name - ComplexBlackBoxDescriptor(const std::string& name); - /// Default dtor - ~ComplexBlackBoxDescriptor(); + static Pointer New(const std::string& name); /// Sets the factory used - void SetFactory(Factory* f) { mFactory = f; } + void SetFactory(Factory::Pointer f) { mFactory = f; } /// Gets the factory used - Factory* GetFactory() { return mFactory; } + Factory::Pointer GetFactory() const { return mFactory.lock(); } + + /// Releases the descriptor + // void Release(bool release_package = true); + /// Gets the factory used (const) - const Factory* GetFactory() const { return mFactory; } + // const Factory* GetFactory() const { return mFactory; } /// Creates an instance of name of the ComplexBlackBox of which this is the descriptor - virtual BlackBox* CreateInstance(const std::string& name); + virtual BlackBoxPointer NewBlackBox(const std::string& name); /// Adds a black box to the complex box /// Needs a factory set ! void Add ( const std::string& type, const std::string& name ); + + /// Removes a black box from the complex box + void Remove( const std::string& name, bool remove_connections = true); + /// Connects two black boxes of the complex box /// Needs a factory set ! void Connect ( const std::string& from, @@ -83,15 +111,11 @@ namespace bbtk const std::string& help); - /// Sets the name of the script file from which it is defined - void SetScriptFileName(const std::string& n) { mScriptFileName = n; } - /// Gets the name of the script file from which it is defined - std::string GetScriptFileName() const { return mScriptFileName; } /// void AddToExecutionList( const std::string& box ); - ComplexBlackBox* GetPrototype() { return mPrototype; } + ComplexBlackBoxPointer GetPrototype() { return mPrototype; } void PrintBlackBoxes(); /// Prints help on the black box @@ -120,24 +144,28 @@ namespace bbtk const std::string& output_dir = "", bool relative_link = false ); + void GetBoxesInside (NodeTreeC& tree, std::vector& list, int cont); + /// + virtual void Check(bool recursive=true) const; + + protected: + /// Default ctor with name is protected + ComplexBlackBoxDescriptor(const std::string& name); + private: - /// Default ctor is private (must have name and factory) - ComplexBlackBoxDescriptor() {} + /// The factory used - Factory* mFactory; + Factory::WeakPointer mFactory; /// The complex box in which boxes and connections are stored - ComplexBlackBox* mPrototype; - /// The name of the script file from which it was created - std::string mScriptFileName; - + ComplexBlackBoxPointer mPrototype; + }; // class ComplexBlackBoxDescriptor //========================================================================== - } // namespace bbtk #endif