X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkBlackBoxDescriptor.h;h=1de5b8cea94c1aaaa8a15655963b4a9ed6d25a9b;hb=6ac9074f717f22c4ffdc6a70d0704c1b1f8fe842;hp=1d0ee5d66510d69b0126d079932cddbb805aeb82;hpb=7eba604321498f7ed6333b7cbe9bf2aceb4ec30e;p=bbtk.git diff --git a/kernel/src/bbtkBlackBoxDescriptor.h b/kernel/src/bbtkBlackBoxDescriptor.h index 1d0ee5d..1de5b8c 100644 --- a/kernel/src/bbtkBlackBoxDescriptor.h +++ b/kernel/src/bbtkBlackBoxDescriptor.h @@ -1,21 +1,34 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkBlackBoxDescriptor.h,v $ Language: C++ - Date: $Date: 2008/02/06 14:14:22 $ - Version: $Revision: 1.5 $ - - 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: 2008/10/17 08:18:12 $ + Version: $Revision: 1.11 $ =========================================================================*/ +/* --------------------------------------------------------------------- + +* 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 bbtk::BlackBoxDescriptor : (abstract) describes of a BlackBox (name, description, author) and is able to create an instance of it. @@ -28,6 +41,7 @@ #ifndef __bbtkBlackBoxDescriptor_h__ #define __bbtkBlackBoxDescriptor_h__ +#include "bbtkObject.h" #include "bbtkBlackBoxInputDescriptor.h" #include "bbtkBlackBoxOutputDescriptor.h" #include @@ -38,10 +52,13 @@ namespace bbtk class BlackBox; class Package; + BBTK_FORWARD_DECLARE_POINTER(BlackBox); + BBTK_FORWARD_DECLARE_POINTER(Package); //========================================================================== - class BBTK_EXPORT BlackBoxDescriptor + class BBTK_EXPORT BlackBoxDescriptor : public Object { + BBTK_ABSTRACT_OBJECT_INTERFACE(BlackBoxDescriptor); public: /// The type of descriptor of inputs typedef BlackBoxInputDescriptor InputDescriptor; @@ -54,23 +71,27 @@ namespace bbtk /// The kinds of black box typedef enum { - STANDARD, - ADAPTOR, - DEFAULT_ADAPTOR + STANDARD=0, + ADAPTOR=1, + DEFAULT_ADAPTOR=2, + GUI=3, + DEFAULT_GUI=4 } Kind; - /// Default ctor - BlackBoxDescriptor(); - /// Default dtor - virtual ~BlackBoxDescriptor(); - /// Creates an instance with name boxname of the BlackBox + /// Releases a descriptor + // static void Release(BlackBoxDescriptor::WeakPointer); + + /// Creates an instance with name boxname of the BlackBox /// of which this is the descriptor - virtual BlackBox* CreateInstance(const std::string& boxname) = 0; + virtual BlackBoxPointer NewBlackBox(const std::string& boxname) = 0; /// Returns the name of the **TYPE** of the black box const std::string& GetTypeName() const { return mTypeName; } + /// Returns the full name of the **TYPE** of the black box (+package name) + std::string GetFullTypeName() const; + /// Returns the description of the BlackBox const std::string& GetDescription() const { return mDescription; } @@ -80,11 +101,8 @@ namespace bbtk /// Returns the category(s) of the BlackBox const std::string& GetCategory() const { return mCategory; } - /// Returns the Package to which the box belongs - Package* GetPackage() { return mPackage; } - - /// Returns the Package to which the box belongs - const Package* GetPackage() const { return mPackage; } + /// Returns the Package to which the box belongs (const pointer) + PackagePointer GetPackage() const { return mPackage; } /// Returns the kind of box Kind GetKind() const { return mKind; } @@ -119,7 +137,7 @@ namespace bbtk void AddToCategory( const std::string&, bool clear = false ); /// Sets the Package to which the box belongs - void SetPackage(Package *package) { mPackage = package; } + void SetPackage(PackagePointer package) { mPackage = package; } /// Sets the kind of box void SetKind(Kind kind) { mKind = kind; } @@ -137,6 +155,8 @@ namespace bbtk int detail, int level, const std::string& output_dir = "", bool relative_link = false ); + /// + virtual void Check(bool recursive=true) const; protected: /// Adds an input descriptor @@ -158,12 +178,12 @@ namespace bbtk /// The kind of box (standard / adaptor) Kind mKind; /// The Package to which the box belongs - Package *mPackage; + PackagePointer mPackage; /// The inputs InputDescriptorMapType mInput; /// The outputs OutputDescriptorMapType mOutput; - + }; // class BlackBoxDescriptor //==========================================================================