Program: bbtk
Module: $RCSfile: bbtkBlackBoxDescriptor.h,v $
Language: C++
- Date: $Date: 2008/01/30 09:28:15 $
- Version: $Revision: 1.2 $
+ Date: $Date: 2008/03/07 08:40:14 $
+ Version: $Revision: 1.6 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
typedef std::map<std::string, InputDescriptor*> InputDescriptorMapType;
/// The type of dictionnary of outputs= map of output descriptors pointers
typedef std::map<std::string, OutputDescriptor*> OutputDescriptorMapType;
- /// The categories of black box
+ /// The kinds of black box
typedef enum
{
STANDARD,
ADAPTOR,
DEFAULT_ADAPTOR
}
- Category;
+ Kind;
/// Default ctor
BlackBoxDescriptor();
/// 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 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
+ /// Returns the Package to which the box belongs (const pointer)
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;
{ return mOutput; }
/// Returns a const pointer on the descriptor of the input of name <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 <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 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; }
- /// 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,
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:
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 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