Program: bbtk
Module: $RCSfile: bbtkBlackBoxDescriptor.h,v $
Language: C++
- Date: $Date: 2008/01/22 15:02:00 $
- Version: $Revision: 1.1 $
+ Date: $Date: 2008/01/30 09:28:15 $
+ Version: $Revision: 1.2 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/// 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 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 Package to which the box belongs
const Package* GetPackage() const { return mPackage; }
+
/// Returns the category of box
Category GetCategory() const { return mCategory; }
-
/// Prints help on the black box
virtual void GetHelp(bool full=true) const;
/// 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 <name>
const InputDescriptor* GetInputDescriptor(const std::string & name) const;
+
/// Returns a const pointer on the descriptor of the output of name <name>
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 keyword list
+ void AddToKeyword( 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; }
std::string mDescription;
/// The author of the black box
std::string mAuthor;
+ /// The keyword of the black box
+ std::string mKeyword;
/// The category of box
Category mCategory;
/// The Package to which the box belongs