#include </home/sspr/src/www/orocos-1.0/export/build/orocos-rtt-1.2.2/build/rtt/SimulationActivity.hpp>
Inheritance diagram for SimulationActivity:
They all run in the same thread, which updates the the system clock such that the SimulationActivity appears to run in realtime, while it runs 'as fast as possible'.
They will run in the SimulationThread. See SimulationThread::Instance for setting the smallest activity period in the system.
Public Member Functions | |
| SimulationActivity (Seconds period, RunnableInterface *r=0) | |
| Construct a SimulationActivity with a periodicity period Seconds. | |
| SimulationActivity (secs s, nsecs ns, RunnableInterface *r=0) | |
| Construct a SimulationActivity with a periodicity of s seconds and ns nanoseconds. | |
| virtual bool | start () |
| A simulated activity can be started also if the SimulationThread is not running yet. | |
| virtual bool | execute () |
| When a SimulationActivity is started, it may be executed by the user as well. | |
| virtual | ~SimulationActivity () |
| Destroys this instance. | |
| bool | run (RunnableInterface *r) |
| Run exclusively this RunnableInterface. | |
| virtual bool | trigger () |
| Trigger that work has to be done. | |
| virtual bool | stop () |
| Stop the activity This will stop the activity by removing it from the 'run-queue' of a thread or call RunnableInterface::breakLoop(). | |
| virtual bool | isRunning () const |
| Query if the activity is initialized and executing. | |
| virtual bool | isActive () const |
| Query if the activity is started. | |
| virtual bool | isPeriodic () const |
| Inspect if this activity is periodic. | |
| virtual Seconds | getPeriod () const |
| Get the periodicity of this activity in Seconds. | |
| virtual OS::ThreadInterface * | thread () |
| Returns a pointer to the thread which will run this activity. | |
| virtual bool | initialize () |
| |
| virtual void | step () |
| |
| virtual void | finalize () |
| |
| void | doStep () |
| Called by the TimerInterface. | |
Protected Member Functions | |
| void | init () |
Protected Attributes | |
| RunnableInterface * | runner |
| When runner != 0 it will be executed instead of this instances initialize(), step() and finalize() functions. | |
| bool | running |
| State info. | |
| bool | active |
| State info. | |
| nsecs | per_ns |
| This activity's period in nanoseconds. | |
| TimerThreadPtr | thread_ |
| The thread which runs this activity. | |
| detail::TimerInterface * | timer_ |
| The timer which steps this activity. | |
| virtual ~SimulationActivity | ( | ) | [virtual] |
Destroys this instance.
The Activity is stopped.
| virtual bool 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 PeriodicActivity.
| bool run | ( | RunnableInterface * | r | ) | [virtual, inherited] |
Run exclusively this RunnableInterface.
| r | The RunnableInterface to run exclusively. |
Implements ActivityInterface.
| virtual bool trigger | ( | ) | [virtual, inherited] |
Trigger that work has to be done.
When you invoke trigger(), you intend to notify the instance that calls execute(), that execute() should be called. This allows a separation between actually executing code (execute()) and notifying that code must be executed (trigger()). A trigger may be ignored by the implementation.
| true | When this->isActive() and the implementation allows external triggers. | |
| false | When !this->isActive() or the implementation does not allow external triggering. |
Implements ActivityInterface.
| virtual bool stop | ( | ) | [virtual, inherited] |
Stop the activity This will stop the activity by removing it from the 'run-queue' of a thread or call RunnableInterface::breakLoop().
If no errors occured, RunnableInterface::finalize() is called.
Implements ActivityInterface.
| virtual bool isRunning | ( | ) | const [virtual, inherited] |
Query if the activity is initialized and executing.
This is more strict than isActive(), it is only true after initialize() is executed and before finalize() is executed. More-over, an Activity may decide to be temporarily not running (not executing code), waiting for a signal to proceed. If this->isActive() and !this->isRunning() then the Activity is in a waiting state.
Implements ActivityInterface.
| virtual bool isActive | ( | ) | const [virtual, inherited] |
Query if the activity is started.
This is less strict than isRunning(), it is true during initialize(), step() or loop() and finalize(). Use this method to check if an activity was start()ed.
Implements ActivityInterface.
| virtual bool isPeriodic | ( | ) | const [virtual, inherited] |
Inspect if this activity is periodic.
If so, it will call RunnableInterface::step(). If the activity is not periodic, it will call RunnableInterface::loop().
Implements ActivityInterface.
| virtual Seconds getPeriod | ( | ) | const [virtual, inherited] |
Get the periodicity of this activity in Seconds.
Implements ActivityInterface.
| virtual OS::ThreadInterface* thread | ( | ) | [virtual, inherited] |
Returns a pointer to the thread which will run this activity.
Will not be null.
Implements ActivityInterface.
1.5.1