bbtk::AtomicBlackBoxInputDescriptor Class Reference

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

#include <bbtkAtomicBlackBoxInputDescriptor.h>

List of all members.

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

---

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.

    : 
    BlackBoxInputDescriptor(creator_type_info,
                            name,description,
                            nature,
                            copy_construct,
                            MANDATORY),
    mGetFunctor(getfunctor),
    mSetFunctor(setfunctor)
  {  
    bbtkDebugMessage("Kernel",9,
                     "AtomicBlackBoxInputDescriptor::"
                     <<"AtomicBlackBoxInputDescriptor(\""
                     <<name<<"\",\""<<description<<"\",\""
                     <<nature<<"\","
                     <<getfunctor<<","<<setfunctor<<","
                     <<copy_construct<<")"<<std::endl);
  }

bbtk::AtomicBlackBoxInputDescriptor::~AtomicBlackBoxInputDescriptor

(

)

Definition at line 69 of file bbtkAtomicBlackBoxInputDescriptor.cxx.

References bbtkDebugMessage, mGetFunctor, and mSetFunctor.

  {
    bbtkDebugMessage("Kernel",9,
                     "AtomicBlackBoxInputDescriptor::"
                     <<"~AtomicBlackBoxInputDescriptor(\""
                     <<GetName()<<"\",\""<<GetDescription()<<"\","
                     <<mGetFunctor<<","<<mSetFunctor<<")"<<std::endl);
  } 

bbtk::AtomicBlackBoxInputDescriptor::AtomicBlackBoxInputDescriptor

(

)

[inline, private]

Default ctor is private.

Definition at line 87 of file bbtkAtomicBlackBoxInputDescriptor.h.

                                    : 
      BlackBoxInputDescriptor(typeid(void),"","","") {}

---

Member Function Documentation

TypeInfo bbtk::AtomicBlackBoxInputDescriptor::GetTypeInfo

(

)

const [inline]

Returns the type of the input.

Definition at line 72 of file bbtkAtomicBlackBoxInputDescriptor.h.

{ return mGetFunctor->GetTypeInfo(); }

std::string bbtk::AtomicBlackBoxInputDescriptor::GetTypeName

(

)

const [inline]

Returns the name of the type of the input.

Definition at line 74 of file bbtkAtomicBlackBoxInputDescriptor.h.

{ return mGetFunctor->GetTypeName(); }

std::string bbtk::AtomicBlackBoxInputDescriptor::GetHumanTypeName

(

)

const [inline]

Returns the name of the type of the input.

Definition at line 76 of file bbtkAtomicBlackBoxInputDescriptor.h.

{ return mGetFunctor->GetHumanTypeName(); }    

virtual bool bbtk::AtomicBlackBoxInputDescriptor::IsPointerType

(

)

const [inline, virtual]

Returns true iff the type is a pointer to class.

Definition at line 78 of file bbtkAtomicBlackBoxInputDescriptor.h.

{ return mGetFunctor->IsPointerType(); }    

AtomicBlackBoxGetFunctor* bbtk::AtomicBlackBoxInputDescriptor::GetGetFunctor

(

)

[inline]

Returns the functor on the Get method.

Definition at line 80 of file bbtkAtomicBlackBoxInputDescriptor.h.

{ return mGetFunctor; }

AtomicBlackBoxSetFunctor* bbtk::AtomicBlackBoxInputDescriptor::GetSetFunctor

(

)

[inline]

Returns the functor on the Set method.

Definition at line 82 of file bbtkAtomicBlackBoxInputDescriptor.h.

{ return mSetFunctor; }

---

Member Data Documentation

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

The functor on the Get method.

Definition at line 90 of file bbtkAtomicBlackBoxInputDescriptor.h.

Referenced by ~AtomicBlackBoxInputDescriptor().

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

The functor on the Set method.

Definition at line 92 of file bbtkAtomicBlackBoxInputDescriptor.h.

Referenced by ~AtomicBlackBoxInputDescriptor().

---

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

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