libalcommon  1.14.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Classes | Public Types | Public Member Functions | Public Attributes
AL::ALMethodInfo Class Reference

ALMethodInfo is the introspection container. More...

#include <alcommon/almethodinfo.h>

List of all members.

Classes

class  ALExample
 ALExample is container for example. More...
class  ALParameterInfo
 ALParameterInfo is the introspection container. More...
class  ALParameterInfoOptional
 ALParameterInfoOptional is the option container. More...

Public Types

enum  methodOption { CPPMethod = 1, AsynchronousMethod = 2, localMethod = 4 }
 methodOption is differents option for the method. More...

Public Member Functions

 ALMethodInfo ()
 Default constructor.
virtual ~ALMethodInfo ()
 Default destructor.
bool isCpp (void)
 Check is the method is used for C++.
bool isAsynchronous (void)
 Check is the method is used as asynchronous one.
bool isLocalMethod (void)
 Check is the method is a local one.
void addOption (int pOption)
 Add method option.
ALFunctorBasegetFunction ()
 Get a pointer to the method.
void clear (void)
 Clear parameters and examples.

Public Attributes

std::string moduleName
std::string methodName
std::string methodDescription
std::vector< ALParameterInfoparameters
std::string returnValue
std::vector< ALExampleexamples
boost::shared_ptr< ALFunctorBaseptrOnMethod
ALParameterInfo returnInfo
short mask

Detailed Description

ALMethodInfo is the introspection container.

We store method description, return type, argument list, examples...

Definition at line 33 of file almethodinfo.h.


Member Enumeration Documentation

methodOption is differents option for the method.

Enumerator:
CPPMethod 

C++ method.

AsynchronousMethod 

Asynchronous method.

localMethod 

Local method.

Definition at line 48 of file almethodinfo.h.


Member Function Documentation

void AL::ALMethodInfo::addOption ( int  pOption) [inline]

Add method option.

Parameters:
pOptionnew option

Definition at line 134 of file almethodinfo.h.

Get a pointer to the method.

Returns:
a pointer to the method

Definition at line 143 of file almethodinfo.h.

bool AL::ALMethodInfo::isAsynchronous ( void  ) [inline]

Check is the method is used as asynchronous one.

Returns:
true if it's a asynchronous method, flase otherwise

Definition at line 118 of file almethodinfo.h.

bool AL::ALMethodInfo::isCpp ( void  ) [inline]

Check is the method is used for C++.

Returns:
true if it's a C++ the method, flase otherwise

Definition at line 110 of file almethodinfo.h.

bool AL::ALMethodInfo::isLocalMethod ( void  ) [inline]

Check is the method is a local one.

Returns:
true if it's a local method, flase otherwise

Definition at line 126 of file almethodinfo.h.


Member Data Documentation

Method example.

Definition at line 100 of file almethodinfo.h.

Method options.

Definition at line 103 of file almethodinfo.h.

Method description.

Definition at line 97 of file almethodinfo.h.

Method name.

Definition at line 96 of file almethodinfo.h.

Module name.

Definition at line 95 of file almethodinfo.h.

Method parameters.

Definition at line 98 of file almethodinfo.h.

Pointer on the mehotd.

Definition at line 101 of file almethodinfo.h.

Info about the return

Definition at line 102 of file almethodinfo.h.

Method return value.

Definition at line 99 of file almethodinfo.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines