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>

Inheritance diagram for bbtk::BlackBoxInputOutputDescriptor:

[legend]

List of all members.

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.

      : mCreatorTypeInfo(creator_type_info),
        mName(name), 
        mDescription(description),
        mNature(nature),
        mCopyConstruct(copy_construct)
    {}

virtual bbtk::BlackBoxInputOutputDescriptor::~BlackBoxInputOutputDescriptor

(

)

[inline, virtual]

Dtor.

Definition at line 68 of file bbtkBlackBoxInputOutputDescriptor.h.

{}

bbtk::BlackBoxInputOutputDescriptor::BlackBoxInputOutputDescriptor

(

)

[inline, protected]

Default ctor is reserved to children.

Definition at line 95 of file bbtkBlackBoxInputOutputDescriptor.h.

                                    : mCreatorTypeInfo(typeid(void)),
                                      mName(""), mDescription(""),
                                      mNature(""),
                                      mCopyConstruct(true)
                                {}

---

Member Function Documentation

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::NewGUI().

{ return mCreatorTypeInfo; }

Here is the caller graph for this function:

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(), and bbtk::WxGUIBlackBoxInfo::InsertInputOutput().

{ return mName; }

Here is the caller graph for this function:

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().

{ return mDescription; }

Here is the caller graph for this function:

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().

{ return mNature; }

Here is the caller graph for this function:

virtual TypeInfo bbtk::BlackBoxInputOutputDescriptor::GetTypeInfo

(

)

const [pure virtual]

Returns the type of the in/output.

Referenced by bbtk::ComplexBlackBoxDescriptor::DefineInput(), bbtk::ComplexBlackBoxDescriptor::DefineOutput(), and bbtk::Interpreter::NewGUI().

Here is the caller graph for this function:

virtual std::string bbtk::BlackBoxInputOutputDescriptor::GetTypeName

(

)

const [pure virtual]

Returns the name of the type of the in/output.

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

Here is the caller graph for this function:

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::NewGUI().

    { return DataInfo(this->GetTypeInfo(),mNature); }

Here is the caller graph for this function:

virtual std::string bbtk::BlackBoxInputOutputDescriptor::GetHumanTypeName

(

)

const [pure virtual]

Returns the name of the type of the in/output.

virtual bool bbtk::BlackBoxInputOutputDescriptor::IsPointerType

(

)

const [pure virtual]

Returns true iff the type is a pointer to class.

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.

{ return mCopyConstruct; }

---

Member Data Documentation

TypeInfo bbtk::BlackBoxInputOutputDescriptor::mCreatorTypeInfo [private]

The TypeInfo of the BlackBoxDescriptor which created this descriptor.

Definition at line 103 of file bbtkBlackBoxInputOutputDescriptor.h.

std::string bbtk::BlackBoxInputOutputDescriptor::mName [private]

The name of the input/output.

Definition at line 105 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::mNature [private]

The nature of the input/output.

Definition at line 109 of file bbtkBlackBoxInputOutputDescriptor.h.

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 documentation for this class was generated from the following file:

• /home/guigues/bbtk-build-tmp/bbtk/kernel/src/bbtkBlackBoxInputOutputDescriptor.h