bbtk::AtomicBlackBoxOutputDescriptor Class Reference

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

#include <bbtkAtomicBlackBoxOutputDescriptor.h>

Inheritance diagram for bbtk::AtomicBlackBoxOutputDescriptor:

Inheritance graph
[legend]
Collaboration diagram for bbtk::AtomicBlackBoxOutputDescriptor:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 AtomicBlackBoxOutputDescriptor (TypeInfo creator_type_info, const std::string &name, const std::string &description, const std::string &nature, AtomicBlackBoxGetFunctor *getfunctor, AtomicBlackBoxSetFunctor *setfunctor, bool copy_construct=true)
 ~AtomicBlackBoxOutputDescriptor ()
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.
AtomicBlackBoxGetFunctorGetGetFunctor ()
 Returns the functor on the Get method.
AtomicBlackBoxSetFunctorGetSetFunctor ()
 Returns the functor on the Set method.
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

 AtomicBlackBoxOutputDescriptor ()
 Default ctor is private.

Private Attributes

AtomicBlackBoxGetFunctormGetFunctor
 The functor on the Get method.
AtomicBlackBoxSetFunctormSetFunctor
 The functor on the Set method.


Detailed Description

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

Definition at line 52 of file bbtkAtomicBlackBoxOutputDescriptor.h.


Constructor & Destructor Documentation

bbtk::AtomicBlackBoxOutputDescriptor::AtomicBlackBoxOutputDescriptor ( 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 44 of file bbtkAtomicBlackBoxOutputDescriptor.cxx.

References bbtkDebugMessage.

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

bbtk::AtomicBlackBoxOutputDescriptor::~AtomicBlackBoxOutputDescriptor (  ) 

Definition at line 68 of file bbtkAtomicBlackBoxOutputDescriptor.cxx.

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

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

Here is the call graph for this function:

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

Default ctor is private.

Definition at line 81 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00081                                      : 
00082       BlackBoxOutputDescriptor(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::AtomicBlackBoxOutputDescriptor::GetGetFunctor (  )  [inline]

Returns the functor on the Get method.

Definition at line 74 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00074 { return mGetFunctor; }

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

Returns the name of the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 71 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00071 { return mGetFunctor->GetHumanTypeName(); }

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

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:

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

Returns the functor on the Set method.

Definition at line 76 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00076 { return mSetFunctor; }

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

Returns the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 67 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00067 { return mGetFunctor->GetTypeInfo(); }

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

Returns the name of the type of the input.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 69 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00069 { return mGetFunctor->GetTypeName(); }

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

Returns true iff the type is a pointer to class.

Implements bbtk::BlackBoxInputOutputDescriptor.

Definition at line 73 of file bbtkAtomicBlackBoxOutputDescriptor.h.

00073 { return mGetFunctor->IsPointerType(); }   


Member Data Documentation

The functor on the Get method.

Definition at line 84 of file bbtkAtomicBlackBoxOutputDescriptor.h.

The functor on the Set method.

Definition at line 86 of file bbtkAtomicBlackBoxOutputDescriptor.h.


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

Generated on Thu May 31 14:14:00 2012 for BBTK by  doxygen 1.5.7.1