Loading...
Searching...
No Matches
dynamicgraph::command::CommandVoid1< E, T > Struct Template Reference

#include <dynamic-graph/command-bind.h>

Inheritance diagram for dynamicgraph::command::CommandVoid1< E, T >:
[legend]
Collaboration diagram for dynamicgraph::command::CommandVoid1< E, T >:
[legend]

Public Types

typedef boost::function< void(const T &) function_t)
 
typedef boost::function< void(E *, const T &) memberFunction_t)
 
typedef void(E::* memberFunction_ptr_t) (const T &)
 

Public Member Functions

 CommandVoid1 (E &entity, function_t function, const std::string &docString)
 
- Public Member Functions inherited from dynamicgraph::command::Command
virtual ~Command ()
 
 Command (Entity &entity, const std::vector< Value::Type > &valueTypes, const std::string &docstring)
 Store the owner entity and a vector of value types.
 
const std::vector< Value::Type > & valueTypes () const
 Return the value type of all parameters.
 
void setParameterValues (const std::vector< Value > &values)
 Set parameter values.
 
const std::vector< Value > & getParameterValues () const
 Get parameter values.
 
Value execute ()
 Execute the command after checking parameters.
 
Entityowner ()
 Get a reference to the Entity owning this command.
 
std::string getDocstring () const
 Get documentation string.
 

Protected Member Functions

virtual Value doExecute ()
 Specific action performed by the command.
 

Additional Inherited Members

- Static Public Attributes inherited from dynamicgraph::command::Command
static const std::vector< Value::TypeEMPTY_ARG
 

Member Typedef Documentation

◆ function_t

template<class E , typename T >
typedef boost::function<void(const T&) dynamicgraph::command::CommandVoid1< E, T >::function_t)

◆ memberFunction_ptr_t

template<class E , typename T >
typedef void(E::* dynamicgraph::command::CommandVoid1< E, T >::memberFunction_ptr_t) (const T &)

◆ memberFunction_t

template<class E , typename T >
typedef boost::function<void(E*,const T&) dynamicgraph::command::CommandVoid1< E, T >::memberFunction_t)

Constructor & Destructor Documentation

◆ CommandVoid1()

template<class E , typename T >
dynamicgraph::command::CommandVoid1< E, T >::CommandVoid1 ( E & entity,
function_t function,
const std::string & docString )
inline

Member Function Documentation

◆ doExecute()

template<class E , typename T >
virtual Value dynamicgraph::command::CommandVoid1< E, T >::doExecute ( )
inlineprotectedvirtual

Specific action performed by the command.

Implements dynamicgraph::command::Command.

References dynamicgraph::command::Command::getParameterValues().