X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkBlackBoxDescriptor.h;h=1d0ee5d66510d69b0126d079932cddbb805aeb82;hb=157b1a61a177ccd0a3136f6e435880d949411c4d;hp=f4694a705484d907a01e532d07618a96bfaaf75e;hpb=a26195c366a89795288009cf7e20f11afa494970;p=bbtk.git diff --git a/kernel/src/bbtkBlackBoxDescriptor.h b/kernel/src/bbtkBlackBoxDescriptor.h index f4694a7..1d0ee5d 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/01/22 15:02:00 $ - Version: $Revision: 1.1 $ + 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 @@ -51,14 +51,14 @@ namespace bbtk typedef std::map InputDescriptorMapType; /// The type of dictionnary of outputs= map of output descriptors pointers typedef std::map OutputDescriptorMapType; - /// The categories of black box + /// The kinds of black box typedef enum { STANDARD, ADAPTOR, DEFAULT_ADAPTOR } - Category; + Kind; /// Default ctor BlackBoxDescriptor(); @@ -70,17 +70,24 @@ namespace bbtk /// Returns the name of the **TYPE** of the black box const std::string& GetTypeName() const { return mTypeName; } + /// 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 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 category of box - Category GetCategory() const { return mCategory; } - + + /// Returns the kind of box + Kind GetKind() const { return mKind; } /// Prints help on the black box virtual void GetHelp(bool full=true) const; @@ -88,24 +95,34 @@ namespace bbtk /// Returns a const ref on the map of input descriptors const InputDescriptorMapType& GetInputDescriptorMap() const { return mInput; } + /// Returns a const ref on the map of output descriptors const OutputDescriptorMapType& GetOutputDescriptorMap() const { 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; } - /// Adds the string to the BlackBox's description + + /// Adds the string to the BlackBox description void AddToDescription( const std::string&, bool clear = false ); - /// Adds the string to the BlackBox's author list + + /// Adds the string to the BlackBox author list void AddToAuthor( 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; } - /// Sets the category of box - void SetCategory(Category category) { mCategory = category; } + + /// Sets the kind of box + void SetKind(Kind kind) { mKind = kind; } /* virtual void InsertHTMLGraph( std::ofstream& s, int detail, int level, @@ -123,10 +140,10 @@ namespace bbtk 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: @@ -136,8 +153,10 @@ namespace bbtk std::string mDescription; /// The author of the black box std::string mAuthor; - /// The category of box - Category mCategory; + /// 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; /// The inputs