#include <command-getter.h>
Public Types | |
typedef T(E::* | GetterMethod) () const |
Pointer to method that sets parameter of type T. More... | |
Public Member Functions | |
Getter (E &entity, GetterMethod getterMethod, const std::string &docString) | |
Constructor. More... | |
Public Member Functions inherited from dynamicgraph::command::Command | |
Command (Entity &entity, const std::vector< Value::Type > &valueTypes, const std::string &docstring) | |
Value | execute () |
Execute the command after checking parameters. More... | |
std::string | getDocstring () const |
Get documentation string. More... | |
const std::vector< Value > & | getParameterValues () const |
Get parameter values. More... | |
Entity & | owner () |
Get a reference to the Entity owning this command. More... | |
void | setParameterValues (const std::vector< Value > &values) |
Set parameter values. More... | |
const std::vector< Value::Type > & | valueTypes () const |
Return the value type of all parameters. More... | |
virtual | ~Command () |
Protected Member Functions | |
virtual Value | doExecute () |
Specific action performed by the command. More... | |
Private Attributes | |
GetterMethod | getterMethod_ |
Additional Inherited Members | |
Static Public Attributes inherited from dynamicgraph::command::Command | |
static const std::vector< Value::Type > | EMPTY_ARG = std::vector<Value::Type>() |
Command that calls a parameter getter function
This class is templated by a type E deriving from entity and a type T of data.
Let us assume that class E has a private member of type T and a public getter function for this member:
Then the command defined by:
returns the value of entity.parameter_
upon invocation.
Definition at line 45 of file command-getter.h.
typedef T(E::* dynamicgraph::command::Getter< E, T >::GetterMethod) () const |
Pointer to method that sets parameter of type T.
Definition at line 48 of file command-getter.h.
dynamicgraph::command::Getter< E, T >::Getter | ( | E & | entity, |
GetterMethod | getterMethod, | ||
const std::string & | docString | ||
) |
Constructor.
Definition at line 19 of file command-getter.t.cpp.
|
protectedvirtual |
Specific action performed by the command.
Implements dynamicgraph::command::Command.
Definition at line 25 of file command-getter.t.cpp.
|
private |
Definition at line 56 of file command-getter.h.