The default, thread-less activity for any newly created TaskContext. More...
#include <SequentialActivity.hpp>
Public Member Functions | |
| bool | breakLoop () |
| bool | breakLoop () |
| bool | execute () |
| bool | execute () |
| void | finalize () |
| void | finalize () |
| unsigned | getCpuAffinity () const |
| unsigned | getCpuAffinity () const |
| Seconds | getPeriod () const |
| Seconds | getPeriod () const |
| bool | initialize () |
| bool | initialize () |
| bool | isActive () const |
| bool | isActive () const |
| bool | isPeriodic () const |
| bool | isPeriodic () const |
| bool | isRunning () const |
| bool | isRunning () const |
| void | loop () |
| void | loop () |
| SequentialActivity (base::RunnableInterface *run=0) | |
| SequentialActivity (base::RunnableInterface *run=0) | |
| bool | setCpuAffinity (unsigned cpu) |
| bool | setCpuAffinity (unsigned cpu) |
| bool | setPeriod (Seconds s) |
| bool | setPeriod (Seconds s) |
| bool | start () |
| bool | start () |
| void | step () |
| void | step () |
| bool | stop () |
| bool | stop () |
| os::ThreadInterface * | thread () |
| os::ThreadInterface * | thread () |
| bool | trigger () |
| bool | trigger () |
| ~SequentialActivity () | |
| ~SequentialActivity () | |
Private Attributes | |
| bool | active |
| os::Mutex | execution_lock |
| bool | running |
The default, thread-less activity for any newly created TaskContext.
The presence of this activity object indicates that the TaskContext does not have its own active thread, but executes all asynchronous operations (such as commands and events) in the thread of the caller, so in fact synchronously. The SequentialActivity uses a os::Mutex lock to guard against concurrent executions and makes your TaskContext equally thread-safe as the other activity implementations.
This activity emulates the same behaviour as a NonPeriodicActivity, but without using a thread.
Always returns false.
This causes step() to be executed.
Definition at line 71 of file install/include/rtt/extras/SequentialActivity.hpp.
| RTT::SequentialActivity::SequentialActivity | ( | base::RunnableInterface * | run = 0 |
) |
Create an activity which is the Sequential. The period will be 0.0.
| run | Run this instance. |
Definition at line 45 of file SequentialActivity.cpp.
| RTT::SequentialActivity::~SequentialActivity | ( | ) |
Cleanup and notify the base::RunnableInterface that we are gone.
Definition at line 50 of file SequentialActivity.cpp.
| RTT::extras::SequentialActivity::SequentialActivity | ( | base::RunnableInterface * | run = 0 |
) |
Create an activity which is the Sequential. The period will be 0.0.
| run | Run this instance. |
| RTT::extras::SequentialActivity::~SequentialActivity | ( | ) |
Cleanup and notify the base::RunnableInterface that we are gone.
| bool RTT::extras::SequentialActivity::breakLoop | ( | ) |
| bool RTT::SequentialActivity::breakLoop | ( | ) |
Definition at line 90 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::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, in which case execute() returns false.
Semantics: If execute() returns true, the activity has been executed exactly once during execute().
| true | When this->isActive() and the implementation allows external executes. | |
| false | When !this->isActive() or the implementation does not allow external updating. |
Implements RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::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, in which case execute() returns false.
Semantics: If execute() returns true, the activity has been executed exactly once during execute().
| true | When this->isActive() and the implementation allows external executes. | |
| false | When !this->isActive() or the implementation does not allow external updating. |
Implements RTT::base::ActivityInterface.
Definition at line 178 of file SequentialActivity.cpp.
| void RTT::extras::SequentialActivity::finalize | ( | ) |
| void RTT::SequentialActivity::finalize | ( | ) |
Definition at line 96 of file SequentialActivity.cpp.
| unsigned RTT::extras::SequentialActivity::getCpuAffinity | ( | ) | const [virtual] |
Get the cpu affinity of this activity
Implements RTT::base::ActivityInterface.
| unsigned RTT::SequentialActivity::getCpuAffinity | ( | ) | const [virtual] |
Get the cpu affinity of this activity
Implements RTT::base::ActivityInterface.
Definition at line 66 of file SequentialActivity.cpp.
| Seconds RTT::extras::SequentialActivity::getPeriod | ( | ) | const [virtual] |
Get the periodicity of this activity in Seconds
Implements RTT::base::ActivityInterface.
| Seconds RTT::SequentialActivity::getPeriod | ( | ) | const [virtual] |
Get the periodicity of this activity in Seconds
Implements RTT::base::ActivityInterface.
Definition at line 55 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::initialize | ( | ) |
| bool RTT::SequentialActivity::initialize | ( | ) |
Definition at line 81 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::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 RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::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 RTT::base::ActivityInterface.
Definition at line 138 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::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 RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::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 RTT::base::ActivityInterface.
Definition at line 133 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::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 RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::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 RTT::base::ActivityInterface.
Definition at line 128 of file SequentialActivity.cpp.
| void RTT::extras::SequentialActivity::loop | ( | ) |
| void RTT::extras::SequentialActivity::loop | ( | ) |
| bool RTT::extras::SequentialActivity::setCpuAffinity | ( | unsigned | cpu | ) | [virtual] |
Set the cpu affinity of this activity.
Implements RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::setCpuAffinity | ( | unsigned | cpu | ) | [virtual] |
Set the cpu affinity of this activity.
Implements RTT::base::ActivityInterface.
Definition at line 71 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::setPeriod | ( | Seconds | s | ) | [virtual] |
Set the periodicity of this activity in Seconds. Note that not all activity implementation support periods. A period of s == 0 indicates non periodic. A non supported setting returns false.
Implements RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::setPeriod | ( | Seconds | s | ) | [virtual] |
Set the periodicity of this activity in Seconds. Note that not all activity implementation support periods. A period of s == 0 indicates non periodic. A non supported setting returns false.
Implements RTT::base::ActivityInterface.
Definition at line 60 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::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 RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::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 RTT::base::ActivityInterface.
Definition at line 100 of file SequentialActivity.cpp.
| void RTT::extras::SequentialActivity::step | ( | ) |
| void RTT::SequentialActivity::step | ( | ) |
Definition at line 86 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::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 RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::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 RTT::base::ActivityInterface.
Definition at line 115 of file SequentialActivity.cpp.
| os::ThreadInterface* RTT::extras::SequentialActivity::thread | ( | ) | [virtual] |
Returns a pointer to the thread which will run this activity. Will not be null.
Implements RTT::base::ActivityInterface.
| os::ThreadInterface * RTT::SequentialActivity::thread | ( | ) | [virtual] |
Returns a pointer to the thread which will run this activity. Will not be null.
Implements RTT::base::ActivityInterface.
Definition at line 76 of file SequentialActivity.cpp.
| bool RTT::extras::SequentialActivity::trigger | ( | ) | [virtual] |
Trigger that work has to be done. When you invoke trigger(), you intend to notify the mechanism 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, in which case trigger returns false.
Semantics: If trigger() returns true, the activity will be executed at least once from the moment trigger() is called.
| true | When this->isActive() and the implementation allows external triggers. | |
| false | When !this->isActive() or the implementation does not allow external triggering. |
Implements RTT::base::ActivityInterface.
| bool RTT::SequentialActivity::trigger | ( | ) | [virtual] |
Trigger that work has to be done. When you invoke trigger(), you intend to notify the mechanism 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, in which case trigger returns false.
Semantics: If trigger() returns true, the activity will be executed at least once from the moment trigger() is called.
| true | When this->isActive() and the implementation allows external triggers. | |
| false | When !this->isActive() or the implementation does not allow external triggering. |
Implements RTT::base::ActivityInterface.
Definition at line 143 of file SequentialActivity.cpp.
bool RTT::extras::SequentialActivity::active [private] |
Definition at line 117 of file install/include/rtt/extras/SequentialActivity.hpp.
Definition at line 118 of file install/include/rtt/extras/SequentialActivity.hpp.
bool RTT::extras::SequentialActivity::running [private] |
Definition at line 116 of file install/include/rtt/extras/SequentialActivity.hpp.
