#include </home/sspr/src/www/orocos-1.0/export/build/orocos-rtt-1.2.2/build/rtt/NonPeriodicActivity.hpp>
Inheritance diagram for NonPeriodicActivity:
By default, (if no RunnableInterface is given and no overloads are present ) loop() returns immediately.
Public Member Functions | |
| NonPeriodicActivity (int priority, RunnableInterface *_r=0) | |
| Create an NonPeriodicActivity with a given priority and RunnableInterface instance. | |
| NonPeriodicActivity (int scheduler, int priority, RunnableInterface *_r=0) | |
| Create an NonPeriodicActivity with a given scheduler type, priority and RunnableInterface instance. | |
| NonPeriodicActivity (int priority, const std::string &name, RunnableInterface *_r=0) | |
| Create an NonPeriodicActivity with a given priority, name and RunnableInterface instance. | |
| bool | run (RunnableInterface *r) |
| Run another (or self in case of null) task. | |
| bool | run (int) |
| Run another (or self in case of null) task. | |
| virtual Seconds | getPeriod () const |
| Get the periodicity of this activity in Seconds. | |
| virtual ThreadInterface * | thread () |
| Returns a pointer to the thread which will run this activity. | |
| virtual bool | initialize () |
| virtual void | loop () |
| virtual bool | breakLoop () |
| virtual void | finalize () |
| virtual bool | isPeriodic () const |
| Inspect if this activity is periodic. | |
| virtual bool | start () |
| Start the activity. | |
| virtual bool | execute () |
| Execute this activity such that it executes a step or loop of the 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. | |
| NonPeriodicActivity | ( | int | priority, | |
| RunnableInterface * | _r = 0 | |||
| ) |
Create an NonPeriodicActivity with a given priority and RunnableInterface instance.
The default scheduler for NonPeriodicActivity objects is ORO_SCHED_RT.
| priority | The priority of the underlying thread. | |
| _r | The optional runner, if none, this->loop() is called. |
| NonPeriodicActivity | ( | int | scheduler, | |
| int | priority, | |||
| RunnableInterface * | _r = 0 | |||
| ) |
Create an NonPeriodicActivity with a given scheduler type, priority and RunnableInterface instance.
| scheduler | The scheduler in which the activitie's thread must run. Use ORO_SCHED_OTHER or ORO_SCHED_RT. | |
| priority | The priority of the underlying thread. | |
| _r | The optional runner, if none, this->loop() is called. |
| NonPeriodicActivity | ( | int | priority, | |
| const std::string & | name, | |||
| RunnableInterface * | _r = 0 | |||
| ) |
Create an NonPeriodicActivity with a given priority, name and RunnableInterface instance.
| priority | The priority of the underlying thread. | |
| name | The name of the underlying thread. | |
| _r | The optional runner, if none, this->loop() is called. |
| bool run | ( | int | ) | [inline] |
Run another (or self in case of null) task.
This overload is needed to redirect the call of run( 0 ) to the correct function.
| virtual Seconds getPeriod | ( | ) | const [virtual] |
Get the periodicity of this activity in Seconds.
Implements ActivityInterface.
| virtual ThreadInterface* thread | ( | ) | [virtual] |
Returns a pointer to the thread which will run this activity.
Will not be null.
Implements ActivityInterface.
| virtual bool isPeriodic | ( | ) | const [virtual] |
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 bool start | ( | ) | [virtual] |
Start the activity.
This will call RunnableInterface::initialize() and upon success, effectively start the activity, by running the RunnableInterface::step() or RunnableInterface::loop() in a thread.
Implements ActivityInterface.
| virtual bool execute | ( | ) | [virtual] |
Execute this activity such that it executes a step or loop of the RunnableInterface.
When you invoke execute() you intend to call the step() or loop() methods. Some activity implementations allow a user controlled execute, others ignore it.
| true | When this->isActive() and the implementation allows external executes. | |
| false | When !this->isActive() or the implementation does not allow external updating. |
Implements ActivityInterface.
| virtual bool trigger | ( | ) | [virtual] |
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] |
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] |
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] |
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.
1.5.1