command-direct-getter.h

Go to the documentation of this file.

//
// Copyright 2010 CNRS
//
// Author: Nicolas Mansard
//

#ifndef __dg_command_direct_getter_h__
#define __dg_command_direct_getter_h__

/* Define a getter command directly on the attribute (no need to pass by
 * an explicit function). A typical use is given here:
 *     addCommand("getSize",
 *                makeDirectGetter(*this,&_dimension,
 *                                 docDirectGetter("dimension","int")));
 *
 */

#include <boost/assign/list_of.hpp>

#include "dynamic-graph/command.h"

/* --- GETTER --------------------------------------------------------- */
namespace dynamicgraph {
namespace command {

template <class E, typename T>
class DirectGetter : public Command {
 public:
  typedef T (E::*GetterMethod)() const;

  DirectGetter(E &entity, T *ptr, const std::string &docString)
      : Command(entity, std::vector<Value::Type>(), docString), T_ptr(ptr) {}

 protected:
  virtual Value doExecute() { return Value(*T_ptr); }

 private:
  T *T_ptr;
};

template <class E, typename T>
DirectGetter<E, T> *makeDirectGetter(E &entity, T *ptr,
                                     const std::string &docString) {
  return new DirectGetter<E, T>(entity, ptr, docString);
}

inline std::string docDirectGetter(const std::string &name,
                                   const std::string &type) {
  return std::string("\nGet the ") + name + ".\n\nNo input.\nReturn an " +
         type + ".\n\n";
}

}  // namespace command
}  // namespace dynamicgraph

#endif  // __dg_command_direct_getter_h__