A SimulationActivity is a PeriodicActivity which is used for simulation. More...
#include <SimulationActivity.hpp>
Public Member Functions | |
| virtual bool | execute () |
| SimulationActivity (Seconds period, base::RunnableInterface *r=0) | |
| SimulationActivity (secs s, nsecs ns, base::RunnableInterface *r=0) | |
| virtual bool | start () |
| virtual os::ThreadInterface * | thread () |
| virtual | ~SimulationActivity () |
Detailed Description
A SimulationActivity is a PeriodicActivity which is used for simulation.
They all run in the same thread at the same period, which updates the the system clock such that the SimulationActivity appears to run in realtime, while it runs 'as fast as possible'.
- Note:
- The period is fixed by the SimulationThread, which runs all SimulationActivities at the same period.
Definition at line 59 of file SimulationActivity.hpp.
Constructor & Destructor Documentation
| RTT::SimulationActivity::SimulationActivity | ( | Seconds | period, |
| base::RunnableInterface * | r = 0 |
||
| ) |
Construct a SimulationActivity with a periodicity period Seconds
- Note:
- period is ignored.
Definition at line 46 of file SimulationActivity.cpp.
| RTT::SimulationActivity::SimulationActivity | ( | secs | s, |
| nsecs | ns, | ||
| base::RunnableInterface * | r = 0 |
||
| ) |
Construct a SimulationActivity with a periodicity of s seconds and ns nanoseconds
- Note:
- s and ns are ignored.
Definition at line 51 of file SimulationActivity.cpp.
| RTT::SimulationActivity::~SimulationActivity | ( | ) | [virtual] |
Destroys this instance. The Activity is stopped.
Definition at line 56 of file SimulationActivity.cpp.
Member Function Documentation
| bool RTT::SimulationActivity::execute | ( | ) | [virtual] |
When a SimulationActivity is started, it may be executed by the user as well.
Reimplemented from RTT::extras::PeriodicActivity.
Definition at line 65 of file SimulationActivity.cpp.
| bool RTT::SimulationActivity::start | ( | ) | [virtual] |
A simulated activity can be started also if the SimulationThread is not running yet. This allows all tasks to be set ready in advance before the whole simulation is started.
Reimplemented from RTT::extras::PeriodicActivity.
Definition at line 76 of file SimulationActivity.cpp.
| os::ThreadInterface * RTT::SimulationActivity::thread | ( | ) | [virtual] |
Returns a pointer to the thread which will run this activity. Will not be null.
Reimplemented from RTT::extras::PeriodicActivity.
Definition at line 61 of file SimulationActivity.cpp.
The documentation for this class was generated from the following files: