mars
Plugin.hpp
Go to the documentation of this file.
1 /* Generated from orogen/lib/orogen/templates/tasks/Task.hpp */
2 
3 #ifndef SIMULATION_MARSPLUGIN_TASK_HPP
4 #define SIMULATION_MARSPLUGIN_TASK_HPP
5 
6 #include <mars/PluginBase.hpp>
7 #include "Task.hpp"
8 #include <mars/interfaces/sim/SimulatorInterface.h>
9 #include <mars/data_broker/ReceiverInterface.h>
10 
11 namespace mars {
12 
27  class Plugin : public PluginBase, public mars::interfaces::PluginInterface, public mars::data_broker::ReceiverInterface
28  {
29  friend class PluginBase;
30  protected:
31  mars::interfaces::SimulatorInterface *sim;
32 
33  public:
38  Plugin(std::string const& name = "mars::Plugin");
39 
45  Plugin(std::string const& name, RTT::ExecutionEngine* engine);
46 
49  ~Plugin();
50 
65  bool configureHook();
66 
72  bool startHook();
73 
88  void updateHook();
89 
96  void errorHook();
97 
101  void stopHook();
102 
107  void cleanupHook();
108 
119  base::Time getTime();
120 
121  bool connect();
122  void disconnect();
123  virtual void reset();
124  virtual void receiveData(const mars::data_broker::DataInfo& info,const mars::data_broker::DataPackage& package,int id);
125  virtual void handleMarsShudown();
126  virtual void init();
127  virtual void update(double delta_t);
128  };
129 };
130 
131 #endif
132 
bool startHook()
Definition: Plugin.cpp:43
mars::interfaces::SimulatorInterface * sim
Definition: Plugin.hpp:31
bool connect()
Definition: Plugin.cpp:89
virtual void reset()
Definition: Plugin.cpp:126
void cleanupHook()
Definition: Plugin.cpp:67
bool configureHook()
The following lines are template definitions for the various state machine.
Definition: Plugin.cpp:26
Plugin(std::string const &name="mars::Plugin")
Definition: Plugin.cpp:7
virtual void receiveData(const mars::data_broker::DataInfo &info, const mars::data_broker::DataPackage &package, int id)
Definition: Plugin.cpp:128
virtual void handleMarsShudown()
Definition: Plugin.cpp:135
void updateHook()
Definition: Plugin.cpp:51
void errorHook()
Definition: Plugin.cpp:56
~Plugin()
Definition: Plugin.cpp:19
friend class PluginBase
Definition: Plugin.hpp:29
Definition: jointTypes.hpp:9
void disconnect()
Definition: Plugin.cpp:118
virtual void update(double delta_t)
Definition: Plugin.cpp:72
void stopHook()
Definition: Plugin.cpp:62
The task context provides and requires services. It uses an ExecutionEngine to perform its functions...
Definition: Plugin.hpp:27
virtual void init()
Definition: Plugin.cpp:76
base::Time getTime()
provides the mars time to be used as timestamps
Definition: Plugin.cpp:80