dynamicgraph::command::Getter< E, T > Class Template Reference

Command that calls a parameter getter function. More...

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

Inheritance diagram for dynamicgraph::command::Getter< E, T >:
Collaboration diagram for dynamicgraph::command::Getter< E, T >:

List of all members.

Public Types

typedef T(E::* GetterMethod )() const
 Pointer to method that sets paramter of type T.

Public Member Functions

 Getter (E &entity, GetterMethod getterMethod, const std::string &docString)
 Constructor.

Protected Member Functions

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

Detailed Description

template<class E, typename T>
class dynamicgraph::command::Getter< E, T >

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:

 class E : public Entity
 {
 public:
   E (const std::string& inName) : Entity(inName) {}
   T getParameter() const {return parameter_;}
 private:
   T parameter_;
 };

Then the command defined by:

 E entity("MyEntity");
 Getter<E,T> command(entity, &E::getParameter)

returns the value of entity.parameter_ upon invocation.

Note:
  • T should be a type supported by class Value,
  • prototype of E::getParameter should be exactly as specified in this example.

Member Typedef Documentation

template<class E , typename T >
typedef T(E::* dynamicgraph::command::Getter< E, T >::GetterMethod)() const

Pointer to method that sets paramter of type T.


Constructor & Destructor Documentation

template<class E , typename T >
dynamicgraph::command::Getter< E, T >::Getter ( E &  entity,
GetterMethod  getterMethod,
const std::string &  docString 
)

Constructor.


Member Function Documentation

template<class E , typename T >
Value dynamicgraph::command::Getter< E, T >::doExecute ( ) [protected, virtual]

Specific action performed by the command.

Implements dynamicgraph::command::Command.