bbtk::AtomicBlackBoxInputDescriptor Class Reference

Structure containing the description of a AtomicBlackBox input (name, description, type, functor). More...

#include <bbtkAtomicBlackBoxInputDescriptor.h>

Inheritance diagram for bbtk::AtomicBlackBoxInputDescriptor:

Collaboration diagram for bbtk::AtomicBlackBoxInputDescriptor:

List of all members.

Public Types

enum OptionType { MANDATORY, OPTIONAL }

Public Member Functions

AtomicBlackBoxInputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, AtomicBlackBoxGetFunctor *getfunctor, AtomicBlackBoxSetFunctor *setfunctor, bool copy_construct=true)

~AtomicBlackBoxInputDescriptor ()

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.

virtual bool IsPointerType () const

Returns true iff the type is a pointer to class.

AtomicBlackBoxGetFunctor * GetGetFunctor ()

Returns the functor on the Get method.

AtomicBlackBoxSetFunctor * GetSetFunctor ()

Returns the functor on the Set method.

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

AtomicBlackBoxInputDescriptor ()

Default ctor is private.

Private Attributes

AtomicBlackBoxGetFunctor * mGetFunctor

The functor on the Get method.

AtomicBlackBoxSetFunctor * mSetFunctor

The functor on the Set method.

Detailed Description

Structure containing the description of a AtomicBlackBox input (name, description, type, functor).

Definition at line 52 of file bbtkAtomicBlackBoxInputDescriptor.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::AtomicBlackBoxInputDescriptor::AtomicBlackBoxInputDescriptor	(	TypeInfo	creator_type_info,
		const std::string &	name,
		const std::string &	description,
		const std::string &	nature,
		AtomicBlackBoxGetFunctor *	getfunctor,
		AtomicBlackBoxSetFunctor *	setfunctor,
		bool	copy_construct = `true`
	)

Definition at line 42 of file bbtkAtomicBlackBoxInputDescriptor.cxx.

References bbtkDebugMessage.

00049     : 
00050     BlackBoxInputDescriptor(creator_type_info,
00051                             name,description,
00052                             nature,
00053                             copy_construct,
00054                             MANDATORY),
00055     mGetFunctor(getfunctor),
00056     mSetFunctor(setfunctor)
00057   {  
00058     bbtkDebugMessage("kernel",9,
00059                      "AtomicBlackBoxInputDescriptor(\""
00060                      <<name<<"\",\""<<description<<"\",\""
00061                      <<nature<<"\","
00062                      <<getfunctor<<","<<setfunctor<<","
00063                      <<copy_construct<<")"<<std::endl);
00064   }

bbtk::AtomicBlackBoxInputDescriptor::~AtomicBlackBoxInputDescriptor ( )

Definition at line 68 of file bbtkAtomicBlackBoxInputDescriptor.cxx.

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

00069   {
00070     bbtkDebugMessage("kernel",9,
00071                      "~AtomicBlackBoxInputDescriptor(\""
00072                      <<GetName()<<"\")"<<std::endl);
00073   }

Here is the call graph for this function:

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

Default ctor is private.

Definition at line 87 of file bbtkAtomicBlackBoxInputDescriptor.h.

00087                                     : 
00088       BlackBoxInputDescriptor(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:

AtomicBlackBoxGetFunctor* bbtk::AtomicBlackBoxInputDescriptor::GetGetFunctor ( ) [inline]

Returns the functor on the Get method.

Definition at line 80 of file bbtkAtomicBlackBoxInputDescriptor.h.

00080 { return mGetFunctor; }

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

Returns the name of the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 76 of file bbtkAtomicBlackBoxInputDescriptor.h.

00076 { return mGetFunctor->GetHumanTypeName(); }

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(), ~AtomicBlackBoxInputDescriptor(), bbtk::AtomicBlackBoxOutputDescriptor::~AtomicBlackBoxOutputDescriptor(), bbtk::ComplexBlackBoxInputDescriptor::~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; }

AtomicBlackBoxSetFunctor* bbtk::AtomicBlackBoxInputDescriptor::GetSetFunctor ( ) [inline]

Returns the functor on the Set method.

Definition at line 82 of file bbtkAtomicBlackBoxInputDescriptor.h.

00082 { return mSetFunctor; }

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

Returns the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 72 of file bbtkAtomicBlackBoxInputDescriptor.h.

00072 { return mGetFunctor->GetTypeInfo(); }

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

Returns the name of the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 74 of file bbtkAtomicBlackBoxInputDescriptor.h.

00074 { return mGetFunctor->GetTypeName(); }

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

Returns true iff the type is a pointer to class.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 78 of file bbtkAtomicBlackBoxInputDescriptor.h.

00078 { return mGetFunctor->IsPointerType(); }

Member Data Documentation

AtomicBlackBoxGetFunctor* bbtk::AtomicBlackBoxInputDescriptor::mGetFunctor [private]

The functor on the Get method.

Definition at line 90 of file bbtkAtomicBlackBoxInputDescriptor.h.

AtomicBlackBoxSetFunctor* bbtk::AtomicBlackBoxInputDescriptor::mSetFunctor [private]

The functor on the Set method.

Definition at line 92 of file bbtkAtomicBlackBoxInputDescriptor.h.

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

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


Public Types
enum	OptionType { MANDATORY, OPTIONAL }
Public Member Functions
	AtomicBlackBoxInputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, AtomicBlackBoxGetFunctor getfunctor, AtomicBlackBoxSetFunctor setfunctor, bool copy_construct=true)
	~AtomicBlackBoxInputDescriptor ()
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.
virtual bool	IsPointerType () const
	Returns true iff the type is a pointer to class.
AtomicBlackBoxGetFunctor *	GetGetFunctor ()
	Returns the functor on the Get method.
AtomicBlackBoxSetFunctor *	GetSetFunctor ()
	Returns the functor on the Set method.
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
	AtomicBlackBoxInputDescriptor ()
	Default ctor is private.
Private Attributes
AtomicBlackBoxGetFunctor *	mGetFunctor
	The functor on the Get method.
AtomicBlackBoxSetFunctor *	mSetFunctor
	The functor on the Set method.