X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkBlackBoxDescriptor.h;h=d826882c5664ca9441f4cff8336492759d0edfd6;hb=9f6d1a6420a64127d9b199fc0f55c01e85485c39;hp=0604f9c02f8ee0f20780ad38c0514a095e16270c;hpb=a7b5e75baf0af42a27092233d3b3350d8ec2d5da;p=bbtk.git diff --git a/kernel/src/bbtkBlackBoxDescriptor.h b/kernel/src/bbtkBlackBoxDescriptor.h index 0604f9c..d826882 100644 --- a/kernel/src/bbtkBlackBoxDescriptor.h +++ b/kernel/src/bbtkBlackBoxDescriptor.h @@ -3,8 +3,8 @@ Program: bbtk Module: $RCSfile: bbtkBlackBoxDescriptor.h,v $ Language: C++ - Date: $Date: 2008/02/05 11:07:42 $ - Version: $Revision: 1.3 $ + Date: $Date: 2008/04/22 06:59:31 $ + Version: $Revision: 1.10 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -28,6 +28,7 @@ #ifndef __bbtkBlackBoxDescriptor_h__ #define __bbtkBlackBoxDescriptor_h__ +#include "bbtkObject.h" #include "bbtkBlackBoxInputDescriptor.h" #include "bbtkBlackBoxOutputDescriptor.h" #include @@ -38,10 +39,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,37 +58,38 @@ 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; } /// Returns the author(s) of the BlackBox const std::string& GetAuthor() const { return mAuthor; } - /// Returns the keyword(s) of the BlackBox - const std::string& GetKeyword() const { return mKeyword; } - - /// Returns the Package to which the box belongs - Package* GetPackage() { return mPackage; } + /// Returns the category(s) of the BlackBox + const std::string& GetCategory() const { return mCategory; } - /// 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; } @@ -101,10 +106,10 @@ namespace bbtk { return mOutput; } /// Returns a const pointer on the descriptor of the input of name - const InputDescriptor* GetInputDescriptor(const std::string & name) const; + const InputDescriptor* GetInputDescriptor(const std::string &name) const; /// Returns a const pointer on the descriptor of the output of name - const OutputDescriptor* GetOutputDescriptor(const std::string & name) const; + const OutputDescriptor* GetOutputDescriptor(const std::string &name) const; /// Sets the name of the **TYPE** of BlackBox void SetTypeName( const std::string& name ) { mTypeName=name; } @@ -115,11 +120,11 @@ namespace bbtk /// Adds the string to the BlackBox author list void AddToAuthor( const std::string&, bool clear = false ); - /// Adds the string to the BlackBox keyword list - void AddToKeyword( const std::string&, bool clear = false ); + /// Adds the string to the BlackBox category list + 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,13 +142,15 @@ 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 - void AddInputDescriptor( BlackBoxInputDescriptor* d ) + void AddInputDescriptor( BlackBoxInputDescriptor *d ) { mInput[d->GetName()] = d; } /// Adds an output descriptor - void AddOutputDescriptor( BlackBoxOutputDescriptor* d ) + void AddOutputDescriptor( BlackBoxOutputDescriptor *d ) { mOutput[d->GetName()] = d; } // private: @@ -153,17 +160,17 @@ namespace bbtk std::string mDescription; /// The author of the black box std::string mAuthor; - /// The keyword of the black box - std::string mKeyword; - /// The kind of box + /// The category of the black box + std::string mCategory; + /// 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 //==========================================================================