bbtk::ComplexBlackBoxInputDescriptor Class Reference

Structure containing the description of a ComplexBlackBox input (name, description, type, mapping). More...

#include <bbtkComplexBlackBoxInputDescriptor.h>

Inheritance diagram for bbtk::ComplexBlackBoxInputDescriptor:

Collaboration diagram for bbtk::ComplexBlackBoxInputDescriptor:

List of all members.

Public Types

enum OptionType { MANDATORY, OPTIONAL }

Public Member Functions

ComplexBlackBoxInputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, const std::string &target, const std::string &input, TypeInfo type)

~ComplexBlackBoxInputDescriptor ()

TypeInfo GetTypeInfo () const

Returns the type of the input.

std::string GetTypeName () const

Returns the name of the type of the input.

std::string GetHumanTypeName () const

Returns the name of the type of the input.

const std::string & GetTarget () const

Returns the target black box.

const std::string & GetInput () const

Returns the input.

bool IsPointerType () const

Returns true iff the type is a pointer to class.

OptionType GetOption () const

Returns the option of the input.

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 DataInfo GetDataInfo () const

Returns the DataInfo of the input (Type+Nature).

bool GetCopyConstruct () const

Private Member Functions

ComplexBlackBoxInputDescriptor ()

Default ctor is private.

Private Attributes

std::string mTarget

std::string mInput

TypeInfo mType

Detailed Description

Structure containing the description of a ComplexBlackBox input (name, description, type, mapping).

Definition at line 51 of file bbtkComplexBlackBoxInputDescriptor.h.

Member Enumeration Documentation

enum bbtk::BlackBoxInputDescriptor::OptionType [inherited]

Enumerator:

MANDATORY
OPTIONAL

Definition at line 52 of file bbtkBlackBoxInputDescriptor.h.

00052                  {
00053       MANDATORY,
00054       OPTIONAL
00055     } OptionType;

Constructor & Destructor Documentation

bbtk::ComplexBlackBoxInputDescriptor::ComplexBlackBoxInputDescriptor	(	TypeInfo	creator_type_info,
		const std::string &	name,
		const std::string &	description,
		const std::string &	nature,
		const std::string &	target,
		const std::string &	input,
		TypeInfo	type
	)

Definition at line 44 of file bbtkComplexBlackBoxInputDescriptor.cxx.

References bbtkDebugMessage.

00051     : 
00052     BlackBoxInputDescriptor(creator_type_info,name,description,nature),
00053     mTarget(target),
00054     mInput(input),
00055     mType(type)
00056   {    
00057     
00058     bbtkDebugMessage("kernel",9,"ComplexBlackBoxInputDescriptor(\""<<name<<"\",\""<<description<<"\",\""<<target<<"\",\""<<input<<"\")"<<std::endl);
00059   }

bbtk::ComplexBlackBoxInputDescriptor::~ComplexBlackBoxInputDescriptor ( )

Definition at line 62 of file bbtkComplexBlackBoxInputDescriptor.cxx.

References bbtkDebugMessage, and bbtk::BlackBoxInputOutputDescriptor::GetName().

00063   {
00064     bbtkDebugMessage("kernel",9,"~ComplexBlackBoxInputDescriptor(\""
00065                      <<GetName()<<"\")"<<std::endl);
00066   }

Here is the call graph for this function:

bbtk::ComplexBlackBoxInputDescriptor::ComplexBlackBoxInputDescriptor ( ) [inline, private]

Default ctor is private.

Definition at line 82 of file bbtkComplexBlackBoxInputDescriptor.h.

00082                                      : 
00083       BlackBoxInputDescriptor(typeid(void),"","",""),
00084       mType(typeid(void)) {}

Member Function Documentation

bool bbtk::BlackBoxInputOutputDescriptor::GetCopyConstruct ( ) const [inline, inherited]

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, inherited]

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; }

Here is the caller graph for this function:

virtual DataInfo bbtk::BlackBoxInputOutputDescriptor::GetDataInfo ( ) const [inline, virtual, inherited]

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); }

Here is the caller graph for this function:

const std::string& bbtk::BlackBoxInputOutputDescriptor::GetDescription ( ) const [inline, inherited]

Returns the description of the in/output.

Definition at line 75 of file bbtkBlackBoxInputOutputDescriptor.h.

Referenced by bbtk::WxGUIBlackBoxInfo::InsertInputOutput().

00075 { return mDescription; }

Here is the caller graph for this function:

std::string bbtk::ComplexBlackBoxInputDescriptor::GetHumanTypeName ( ) const [inline, virtual]

Returns the name of the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 71 of file bbtkComplexBlackBoxInputDescriptor.h.

References bbtk::HumanTypeName().

00071 { return HumanTypeName(mType); }

Here is the call graph for this function:

const std::string& bbtk::ComplexBlackBoxInputDescriptor::GetInput ( ) const [inline]

Returns the input.

Definition at line 75 of file bbtkComplexBlackBoxInputDescriptor.h.

Referenced by bbtk::ComplexBlackBox::bbAllocateConnectors(), bbtk::ComplexBlackBox::bbBruteForceSetInputPointer(), bbtk::ComplexBlackBox::bbGetInput(), bbtk::ComplexBlackBox::bbSetInput(), and bbtk::ComplexBlackBox::bbWriteDotFileBlackBox().

00075 { return mInput; }

Here is the caller graph for this function:

const std::string& bbtk::BlackBoxInputOutputDescriptor::GetName ( ) const [inline, inherited]

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(), ~ComplexBlackBoxInputDescriptor(), and bbtk::ComplexBlackBoxOutputDescriptor::~ComplexBlackBoxOutputDescriptor().

00073 { return mName; }

Here is the caller graph for this function:

const std::string& bbtk::BlackBoxInputOutputDescriptor::GetNature ( ) const [inline, inherited]

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; }

Here is the caller graph for this function:

OptionType bbtk::BlackBoxInputDescriptor::GetOption ( ) const [inline, inherited]

Returns the option of the input.

Definition at line 72 of file bbtkBlackBoxInputDescriptor.h.

00072 { return mOption; }

const std::string& bbtk::ComplexBlackBoxInputDescriptor::GetTarget ( ) const [inline]

Returns the target black box.

Definition at line 73 of file bbtkComplexBlackBoxInputDescriptor.h.

Referenced by bbtk::ComplexBlackBox::bbAllocateConnectors(), bbtk::ComplexBlackBox::bbBruteForceSetInputPointer(), bbtk::ComplexBlackBox::bbGetInput(), bbtk::ComplexBlackBox::bbSetInput(), and bbtk::ComplexBlackBox::bbWriteDotFileBlackBox().

00073 { return mTarget; }

Here is the caller graph for this function:

TypeInfo bbtk::ComplexBlackBoxInputDescriptor::GetTypeInfo ( ) const [inline, virtual]

Returns the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 67 of file bbtkComplexBlackBoxInputDescriptor.h.

00067 { return mType; }

std::string bbtk::ComplexBlackBoxInputDescriptor::GetTypeName ( ) const [inline, virtual]

Returns the name of the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 69 of file bbtkComplexBlackBoxInputDescriptor.h.

References bbtk::TypeName().

00069 { return TypeName(mType); }

Here is the call graph for this function:

bool bbtk::ComplexBlackBoxInputDescriptor::IsPointerType ( ) const [inline, virtual]

Returns true iff the type is a pointer to class.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 77 of file bbtkComplexBlackBoxInputDescriptor.h.

00077 { return false; }

Member Data Documentation

std::string bbtk::ComplexBlackBoxInputDescriptor::mInput [private]

Definition at line 86 of file bbtkComplexBlackBoxInputDescriptor.h.

std::string bbtk::ComplexBlackBoxInputDescriptor::mTarget [private]

Definition at line 85 of file bbtkComplexBlackBoxInputDescriptor.h.

TypeInfo bbtk::ComplexBlackBoxInputDescriptor::mType [private]

Definition at line 87 of file bbtkComplexBlackBoxInputDescriptor.h.

The documentation for this class was generated from the following files:

/Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkComplexBlackBoxInputDescriptor.h
/Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkComplexBlackBoxInputDescriptor.cxx


Public Types
enum	OptionType { MANDATORY, OPTIONAL }
Public Member Functions
	ComplexBlackBoxInputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, const std::string &target, const std::string &input, TypeInfo type)
	~ComplexBlackBoxInputDescriptor ()
TypeInfo	GetTypeInfo () const
	Returns the type of the input.
std::string	GetTypeName () const
	Returns the name of the type of the input.
std::string	GetHumanTypeName () const
	Returns the name of the type of the input.
const std::string &	GetTarget () const
	Returns the target black box.
const std::string &	GetInput () const
	Returns the input.
bool	IsPointerType () const
	Returns true iff the type is a pointer to class.
OptionType	GetOption () const
	Returns the option of the input.
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 DataInfo	GetDataInfo () const
	Returns the DataInfo of the input (Type+Nature).
bool	GetCopyConstruct () const
Private Member Functions
	ComplexBlackBoxInputDescriptor ()
	Default ctor is private.
Private Attributes
std::string	mTarget
std::string	mInput
TypeInfo	mType