bbtk::BlackBoxInputOutputDescriptor Class Reference
Abstract descriptor of an input or an output of a black box (has a name, description, type and nature). More...
#include <bbtkBlackBoxInputOutputDescriptor.h>
Public Member Functions | |
| BlackBoxInputOutputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, bool copy_construct=true) | |
| Ctor with name, description and naure. | |
| virtual | ~BlackBoxInputOutputDescriptor () |
| Dtor. | |
| TypeInfo | GetCreatorTypeInfo () const |
| Returns the TypeInfo of the BlackBoxDescriptor which created this descriptor. | |
| const std::string & | GetName () const |
| Returns the name of the in/output. | |
| const std::string & | GetDescription () const |
| Returns the description of the in/output. | |
| const std::string & | GetNature () const |
| Returns the nature of the in/output. | |
| virtual TypeInfo | GetTypeInfo () const =0 |
| Returns the type of the in/output. | |
| virtual std::string | GetTypeName () const =0 |
| Returns the name of the type of the in/output. | |
| virtual DataInfo | GetDataInfo () const |
| Returns the DataInfo of the input (Type+Nature). | |
| virtual std::string | GetHumanTypeName () const =0 |
| Returns the name of the type of the in/output. | |
| virtual bool | IsPointerType () const =0 |
| Returns true iff the type is a pointer to class. | |
| bool | GetCopyConstruct () const |
Protected Member Functions | |
| BlackBoxInputOutputDescriptor () | |
| Default ctor is reserved to children. | |
Private Attributes | |
| TypeInfo | mCreatorTypeInfo |
| The TypeInfo of the BlackBoxDescriptor which created this descriptor. | |
| std::string | mName |
| The name of the input/output. | |
| std::string | mDescription |
| The description of the input/output. | |
| std::string | mNature |
| The nature of the input/output. | |
| bool | mCopyConstruct |
Detailed Description
Abstract descriptor of an input or an output of a black box (has a name, description, type and nature).Definition at line 51 of file bbtkBlackBoxInputOutputDescriptor.h.
Constructor & Destructor Documentation
| bbtk::BlackBoxInputOutputDescriptor::BlackBoxInputOutputDescriptor | ( | TypeInfo | creator_type_info, | |
| const std::string & | name, | |||
| const std::string & | description, | |||
| const std::string & | nature, | |||
| bool | copy_construct = true | |||
| ) | [inline] |
Ctor with name, description and naure.
Definition at line 55 of file bbtkBlackBoxInputOutputDescriptor.h.
00061 : mCreatorTypeInfo(creator_type_info), 00062 mName(name), 00063 mDescription(description), 00064 mNature(nature), 00065 mCopyConstruct(copy_construct) 00066 {}
| virtual bbtk::BlackBoxInputOutputDescriptor::~BlackBoxInputOutputDescriptor | ( | ) | [inline, virtual] |
| bbtk::BlackBoxInputOutputDescriptor::BlackBoxInputOutputDescriptor | ( | ) | [inline, protected] |
Default ctor is reserved to children.
Definition at line 95 of file bbtkBlackBoxInputOutputDescriptor.h.
00095 : mCreatorTypeInfo(typeid(void)), 00096 mName(""), mDescription(""), 00097 mNature(""), 00098 mCopyConstruct(true) 00099 {}
Member Function Documentation
| bool bbtk::BlackBoxInputOutputDescriptor::GetCopyConstruct | ( | ) | const [inline] |
Returns true iff the in/output must be copied by the copy constructor of the box
Definition at line 91 of file bbtkBlackBoxInputOutputDescriptor.h.
00091 { return mCopyConstruct; }
| TypeInfo bbtk::BlackBoxInputOutputDescriptor::GetCreatorTypeInfo | ( | ) | const [inline] |
Returns the TypeInfo of the BlackBoxDescriptor which created this descriptor.
Definition at line 71 of file bbtkBlackBoxInputOutputDescriptor.h.
Referenced by bbtk::Interpreter::commandNewGUI().
00071 { return mCreatorTypeInfo; }
| virtual DataInfo bbtk::BlackBoxInputOutputDescriptor::GetDataInfo | ( | ) | const [inline, virtual] |
Returns the DataInfo of the input (Type+Nature).
Definition at line 83 of file bbtkBlackBoxInputOutputDescriptor.h.
Referenced by bbtk::Interpreter::commandNewGUI().
00084 { return DataInfo(this->GetTypeInfo(),mNature); }
| const std::string& bbtk::BlackBoxInputOutputDescriptor::GetDescription | ( | ) | const [inline] |
Returns the description of the in/output.
Definition at line 75 of file bbtkBlackBoxInputOutputDescriptor.h.
Referenced by bbtk::WxGUIBlackBoxInfo::InsertInputOutput().
00075 { return mDescription; }
| virtual std::string bbtk::BlackBoxInputOutputDescriptor::GetHumanTypeName | ( | ) | const [pure virtual] |
Returns the name of the type of the in/output.
Implemented in bbtk::AtomicBlackBoxInputDescriptor, bbtk::AtomicBlackBoxOutputDescriptor, bbtk::ComplexBlackBoxInputDescriptor, and bbtk::ComplexBlackBoxOutputDescriptor.
| const std::string& bbtk::BlackBoxInputOutputDescriptor::GetName | ( | ) | const [inline] |
Returns the name of the in/output.
Definition at line 73 of file bbtkBlackBoxInputOutputDescriptor.h.
Referenced by bbtk::BlackBoxDescriptor::AddInputDescriptor(), bbtk::BlackBoxDescriptor::AddOutputDescriptor(), bbtk::ComplexBlackBox::bbWriteDotFileBlackBox(), bbtk::WxGUIBlackBoxInfo::InsertInputOutput(), bbtk::AtomicBlackBoxInputDescriptor::~AtomicBlackBoxInputDescriptor(), bbtk::AtomicBlackBoxOutputDescriptor::~AtomicBlackBoxOutputDescriptor(), bbtk::ComplexBlackBoxInputDescriptor::~ComplexBlackBoxInputDescriptor(), and bbtk::ComplexBlackBoxOutputDescriptor::~ComplexBlackBoxOutputDescriptor().
00073 { return mName; }
| const std::string& bbtk::BlackBoxInputOutputDescriptor::GetNature | ( | ) | const [inline] |
Returns the nature of the in/output.
Definition at line 77 of file bbtkBlackBoxInputOutputDescriptor.h.
Referenced by bbtk::ComplexBlackBoxDescriptor::DefineInput(), bbtk::ComplexBlackBoxDescriptor::DefineOutput(), and bbtk::WxGUIBlackBoxInfo::InsertInputOutput().
00077 { return mNature; }
| virtual TypeInfo bbtk::BlackBoxInputOutputDescriptor::GetTypeInfo | ( | ) | const [pure virtual] |
Returns the type of the in/output.
Implemented in bbtk::AtomicBlackBoxInputDescriptor, bbtk::AtomicBlackBoxOutputDescriptor, bbtk::ComplexBlackBoxInputDescriptor, and bbtk::ComplexBlackBoxOutputDescriptor.
Referenced by bbtk::Interpreter::commandNewGUI(), bbtk::ComplexBlackBoxDescriptor::DefineInput(), and bbtk::ComplexBlackBoxDescriptor::DefineOutput().
| virtual std::string bbtk::BlackBoxInputOutputDescriptor::GetTypeName | ( | ) | const [pure virtual] |
Returns the name of the type of the in/output.
Implemented in bbtk::AtomicBlackBoxInputDescriptor, bbtk::AtomicBlackBoxOutputDescriptor, bbtk::ComplexBlackBoxInputDescriptor, and bbtk::ComplexBlackBoxOutputDescriptor.
Referenced by bbtk::WxGUIBlackBoxInfo::InsertInputOutput().
| virtual bool bbtk::BlackBoxInputOutputDescriptor::IsPointerType | ( | ) | const [pure virtual] |
Returns true iff the type is a pointer to class.
Implemented in bbtk::AtomicBlackBoxInputDescriptor, bbtk::AtomicBlackBoxOutputDescriptor, bbtk::ComplexBlackBoxInputDescriptor, and bbtk::ComplexBlackBoxOutputDescriptor.
Member Data Documentation
bool bbtk::BlackBoxInputOutputDescriptor::mCopyConstruct [private] |
Does the in/output has to be copied by copy constructor default = true. Must be set to false if it is initialized by the user in bbUserCopyConstructor (typically if it is a pointer)
Definition at line 114 of file bbtkBlackBoxInputOutputDescriptor.h.
The TypeInfo of the BlackBoxDescriptor which created this descriptor.
Definition at line 103 of file bbtkBlackBoxInputOutputDescriptor.h.
std::string bbtk::BlackBoxInputOutputDescriptor::mDescription [private] |
The description of the input/output.
Definition at line 107 of file bbtkBlackBoxInputOutputDescriptor.h.
std::string bbtk::BlackBoxInputOutputDescriptor::mName [private] |
std::string bbtk::BlackBoxInputOutputDescriptor::mNature [private] |
The documentation for this class was generated from the following file:
- /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkBlackBoxInputOutputDescriptor.h
