command.h

Go to the documentation of this file.

//
// Copyright 2010 CNRS
//
// Author: Florent Lamiraux
//

#ifndef DYNAMIC_GRAPH_COMMAND_H
#define DYNAMIC_GRAPH_COMMAND_H

#include <vector>

#include "dynamic-graph/dynamic-graph-api.h"
#include "dynamic-graph/value.h"

namespace dynamicgraph {
class Entity;
namespace command {
class DYNAMIC_GRAPH_DLLAPI Command {
 public:
  virtual ~Command();
  Command(Entity &entity, const std::vector<Value::Type> &valueTypes,
          const std::string &docstring);
  const std::vector<Value::Type> &valueTypes() const;
  void setParameterValues(const std::vector<Value> &values);
  const std::vector<Value> &getParameterValues() const;
  Value execute();
  Entity &owner();
  std::string getDocstring() const;

 protected:
  virtual Value doExecute() = 0;

 private:
  Entity &owner_;
  std::vector<Value::Type> valueTypeVector_;
  std::vector<Value> valueVector_;
  std::string docstring_;

 public:
  static const std::vector<Value::Type> EMPTY_ARG;
};
}  // namespace command
}  // namespace dynamicgraph

#endif  // DYNAMIC_GRAPH_COMMAND_H