bbtk::BlackBoxOutputDescriptor Class Reference

Abstract descriptor of an output of a black box (stores a name, a description and type). More...

#include <bbtkBlackBoxOutputDescriptor.h>

Inheritance diagram for bbtk::BlackBoxOutputDescriptor:

[legend]

Collaboration diagram for bbtk::BlackBoxOutputDescriptor:

[legend]

List of all members.

Public Member Functions
	BlackBoxOutputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, bool copy_construct=true)
	Ctor with name and description.
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
	BlackBoxOutputDescriptor ()
	Default ctor is reserved to children.

---

Detailed Description

Abstract descriptor of an output of a black box (stores a name, a description and type).

Definition at line 49 of file bbtkBlackBoxOutputDescriptor.h.

---

Constructor & Destructor Documentation

bbtk::BlackBoxOutputDescriptor::BlackBoxOutputDescriptor	(	TypeInfo	creator_type_info,
		const std::string &	name,
		const std::string &	description,
		const std::string &	nature,
		bool	copy_construct = true
	)			[inline]

Ctor with name and description.

Definition at line 54 of file bbtkBlackBoxOutputDescriptor.h.

      : BlackBoxInputOutputDescriptor(creator_type_info,name,
                                      description,
                                      nature,
                                      copy_construct)
    {}

bbtk::BlackBoxOutputDescriptor::BlackBoxOutputDescriptor

(

)

[inline, protected]

Default ctor is reserved to children.

Definition at line 67 of file bbtkBlackBoxOutputDescriptor.h.

                               : 
      BlackBoxInputOutputDescriptor()
    {}

---

Member Function Documentation

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

{ return mCreatorTypeInfo; }

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

{ return mName; }

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

{ return mDescription; }

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

{ return mNature; }

Here is the caller graph for this function:

virtual TypeInfo bbtk::BlackBoxInputOutputDescriptor::GetTypeInfo

(

)

const [pure virtual, inherited]

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

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

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

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

virtual bool bbtk::BlackBoxInputOutputDescriptor::IsPointerType

(

)

const [pure virtual, inherited]

Returns true iff the type is a pointer to class.

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.

{ return mCopyConstruct; }

---

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

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