dynamicgraph::command::Setter< E, std::string > Class Template Reference
Inheritance diagram for dynamicgraph::command::Setter< E, std::string >:
[legend]
Collaboration diagram for dynamicgraph::command::Setter< E, std::string >:
[legend]

Public Types

typedef void(E::* SetterMethod) (const std::string &)
 Pointer to method that sets parameter of type std::string. More...
 

Public Member Functions

 Setter (E &entity, SetterMethod setterMethod, const std::string &docString)
 Constructor. More...
 
- 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. More...
 
const std::vector< Value::Type > & valueTypes () const
 Return the value type of all parameters. More...
 
void setParameterValues (const std::vector< Value > &values)
 Set parameter values. More...
 
const std::vector< Value > & getParameterValues () const
 Get parameter values. More...
 
Value execute ()
 Execute the command after checking parameters. More...
 
Entityowner ()
 Get a reference to the Entity owning this command. More...
 
std::string getDocstring () const
 Get documentation string. More...
 

Protected Member Functions

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

Additional Inherited Members

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

Member Typedef Documentation

◆ SetterMethod

template<class E >
typedef void(E::* dynamicgraph::command::Setter< E, std::string >::SetterMethod) (const std::string &)

Pointer to method that sets parameter of type std::string.

Constructor & Destructor Documentation

◆ Setter()

template<class E >
dynamicgraph::command::Setter< E, std::string >::Setter ( E &  entity,
SetterMethod  setterMethod,
const std::string &  docString 
)

Constructor.

Member Function Documentation

◆ doExecute()

template<class E >
Value dynamicgraph::command::Setter< E, std::string >::doExecute ( )
protectedvirtual