X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkBlackBoxDescriptor.h;h=8124b35a10689f9c97d0cb3ccf3aad4108d38996;hb=e123c635cfb290e1936b9765d97d097500170f26;hp=1c15241daa8343ec353391fb63198c645b6cff78;hpb=998354bb81a4f450cae3a2263838d7d3b6024bac;p=bbtk.git diff --git a/kernel/src/bbtkBlackBoxDescriptor.h b/kernel/src/bbtkBlackBoxDescriptor.h index 1c15241..8124b35 100644 --- a/kernel/src/bbtkBlackBoxDescriptor.h +++ b/kernel/src/bbtkBlackBoxDescriptor.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: bbtkBlackBoxDescriptor.h,v $ Language: C++ - Date: $Date: 2008/02/05 12:16:55 $ - Version: $Revision: 1.4 $ - - 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.13 $ =========================================================================*/ + /** * \file * \brief Class bbtk::BlackBoxDescriptor : (abstract) describes of a BlackBox (name, description, author) and is able to create an instance of it. @@ -28,20 +46,24 @@ #ifndef __bbtkBlackBoxDescriptor_h__ #define __bbtkBlackBoxDescriptor_h__ +#include "bbtkObject.h" #include "bbtkBlackBoxInputDescriptor.h" #include "bbtkBlackBoxOutputDescriptor.h" #include #include - +#include "bbtkUtilities.h" 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 +76,34 @@ 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 + typedef enum + { + TS_BINARY=0, + TS_SCRIPT_COMPLEXBOX=1, + TS_SCRIPT_APPLICATION=2 + } TypeOfScript; + + /// 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 +113,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 +149,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,7 +167,38 @@ namespace bbtk int detail, int level, const std::string& output_dir = "", bool relative_link = false ); - + /// + virtual void Check(bool recursive=true) const; + + virtual void GetBoxesInside (NodeTreeC& tree, int cont); + + /// 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; } + + + + + /// Gets the type of script BINARY, SCRIPT_COMPLEXBOX, SCRIPT_APPLICATION + TypeOfScript GetTypeOfScript() { return mTypeOfScript; }; + void SetTypeOfScript(TypeOfScript type) { mTypeOfScript=type; }; + bool IsTypeOfScript_Application(); + bool IsTypeOfScript_ComplexBox(); + void SetTypeOfScript_Application(); + + + + + private: + + TypeOfScript mTypeOfScript; + + /// The name of the script file from which it was created + std::string mScriptFileName; + + + protected: /// Adds an input descriptor void AddInputDescriptor( BlackBoxInputDescriptor *d ) @@ -155,15 +216,15 @@ namespace bbtk std::string mAuthor; /// The category of the black box std::string mCategory; - /// The kind of box + /// 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 //==========================================================================