RTT::scripting::CommandFunction Class Reference

#include <CommandFunctors.hpp>

Inheritance diagram for RTT::scripting::CommandFunction:

[legend]

List of all members.

Public Types
typedef boost::function< bool(void)>	Function
Public Member Functions
virtual CommandFunction *	clone () const
	CommandFunction (Function impl)
virtual bool	execute ()
virtual void	readArguments ()
Public Attributes
Function	com

---

Detailed Description

A functor with the base::ActionInterface, for the case where the functor is a bool(void).

Definition at line 54 of file CommandFunctors.hpp.

---

Member Typedef Documentation

typedef boost::function<bool(void)> RTT::scripting::CommandFunction::Function

Definition at line 50 of file CommandFunctors.hpp.

---

Constructor & Destructor Documentation

RTT::scripting::CommandFunction::CommandFunction

(

Function

impl

)

[inline]

Definition at line 57 of file CommandFunctors.hpp.

---

Member Function Documentation

virtual CommandFunction* RTT::scripting::CommandFunction::clone

(

)

const [inline, virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 66 of file CommandFunctors.hpp.

virtual bool RTT::scripting::CommandFunction::execute

(

)

[inline, virtual]

Execute the functionality of this action.

Returns:

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 64 of file CommandFunctors.hpp.

virtual void RTT::scripting::CommandFunction::readArguments

(

)

[inline, virtual]

This is invoked some time before execute() at a time when the action may read its function arguments.

Implements RTT::base::ActionInterface.

Definition at line 62 of file CommandFunctors.hpp.

---

Member Data Documentation

Function RTT::scripting::CommandFunction::com

Definition at line 52 of file CommandFunctors.hpp.

---

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

• CommandFunctors.hpp