XabslSkillWrapper Class Reference

Xabsl Skill Wrapper. More...

#include <skill_wrapper.h>

List of all members.


Classes

class  ParameterValue
class  ParameterValueBase

Public Types

typedef std::list< std::pair
< std::string, std::string > > 		ParameterList
 Parameter list.

Public Member Functions

 XabslSkillWrapper (const char *name, xabsl::ErrorHandler &error_handler, ParameterList &params)
 Constructor.
 ~XabslSkillWrapper ()
 Destructor.
virtual void registerParameters ()
 Register parameters.
virtual void execute ()
 Execute skill.
const char * name ()
 Get name of the skill.
std::string skill_string ()
 Get skill string for this string.

Detailed Description

Xabsl Skill Wrapper.

This wraps a Fawkes skill as a basic behavior for Xabsl.

Author:
Tim Niemueller

Definition at line 33 of file skill_wrapper.h.

Member Typedef Documentation

typedef std::list<std::pair<std::string, std::string> > XabslSkillWrapper::ParameterList

Parameter list.

Defines the parameters of a skill. It's a list of name/type pairs. The name is the name of the parameter, the type is the value type.

Definition at line 40 of file skill_wrapper.h.

Constructor & Destructor Documentation

XabslSkillWrapper::XabslSkillWrapper ( const char *  name,
xabsl::ErrorHandler &  error_handler,
ParameterList &  params 
)

Constructor.

Parameters:
name name of the skill
error_handler Xabsl error handler
params parameters of this skill

Definition at line 41 of file skill_wrapper.cpp.

XabslSkillWrapper::~XabslSkillWrapper (  ) 

Destructor.

Definition at line 52 of file skill_wrapper.cpp.

Member Function Documentation

void XabslSkillWrapper::execute (  )  [virtual]

Execute skill.

Definition at line 97 of file skill_wrapper.cpp.

const char * XabslSkillWrapper::name (  ) 

Get name of the skill.

Returns:
skill name

Definition at line 66 of file skill_wrapper.cpp.

Referenced by XabslEngineThread::init().

void XabslSkillWrapper::registerParameters (  )  [virtual]

Register parameters.

Definition at line 74 of file skill_wrapper.cpp.

std::string XabslSkillWrapper::skill_string (  ) 

Get skill string for this string.

If execution has been ordered with execute() this method will return a skill string generated based on the given skill name and the parameter list.

Returns:
skill string if executed, empty string otherwise

Definition at line 109 of file skill_wrapper.cpp.

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