Public Types | Public Member Functions | Public Attributes | List of all members
RTT::scripting::CommandFunction Class Reference

#include <CommandFunctors.hpp>

Inheritance diagram for RTT::scripting::CommandFunction:
Inheritance graph
[legend]

Public Types

typedef boost::function< bool(void)> Function
 
- Public Types inherited from RTT::base::ActionInterface
typedef boost::shared_ptr< ActionInterfaceshared_ptr
 

Public Member Functions

virtual CommandFunctionclone () const
 
 CommandFunction (Function impl)
 
virtual bool execute ()
 
virtual void readArguments ()
 
- Public Member Functions inherited from RTT::base::ActionInterface
virtual ActionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
 
virtual void reset ()
 
virtual bool valid () const
 
virtual ~ActionInterface ()
 

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 57 of file CommandFunctors.hpp.

Member Typedef Documentation

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

Definition at line 61 of file CommandFunctors.hpp.

Constructor & Destructor Documentation

RTT::scripting::CommandFunction::CommandFunction ( Function  impl)
inline

Definition at line 68 of file CommandFunctors.hpp.

Member Function Documentation

virtual CommandFunction* RTT::scripting::CommandFunction::clone ( ) const
inlinevirtual

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 77 of file CommandFunctors.hpp.

virtual bool RTT::scripting::CommandFunction::execute ( )
inlinevirtual

Execute the functionality of this action.

Returns
true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 75 of file CommandFunctors.hpp.

virtual void RTT::scripting::CommandFunction::readArguments ( )
inlinevirtual

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 73 of file CommandFunctors.hpp.

Member Data Documentation

Function RTT::scripting::CommandFunction::com

Definition at line 63 of file CommandFunctors.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47