RTT::ActivityInterface Class Reference
[Activity (thread) classes.]
Interface to start/stop and query a Activity. More...
#include <rtt/ActivityInterface.hpp>
Public Types | |
|
typedef boost::shared_ptr < ActivityInterface > | shared_ptr |
Public Member Functions | |
| ActivityInterface (RunnableInterface *run) | |
| virtual bool | run (RunnableInterface *r) |
| Run exclusively this RunnableInterface. | |
| virtual bool | start ()=0 |
| Start the activity. | |
| virtual bool | stop ()=0 |
| 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 =0 |
| Query if the activity is initialized and executing. | |
| virtual bool | isActive () const =0 |
| Query if the activity is started. | |
| virtual Seconds | getPeriod () const =0 |
| Get the periodicity of this activity in Seconds. | |
| virtual bool | isPeriodic () const =0 |
| Inspect if this activity is periodic. | |
| virtual bool | execute ()=0 |
| Execute this activity such that it executes a step or loop of the RunnableInterface. | |
| virtual bool | trigger ()=0 |
| Trigger that work has to be done. | |
| virtual OS::ThreadInterface * | thread ()=0 |
| Returns a pointer to the thread which will run this activity. | |
Protected Member Functions | |
| void | disableRun (RunnableInterface *caller) |
| This method is only meant for RunnableInterface (ie runner) in order to inform the ActivityInterface it should no longer be used. | |
Protected Attributes | |
| RunnableInterface * | runner |
Friends | |
| class | RunnableInterface |
Detailed Description
Interface to start/stop and query a Activity.
A ActivityInterface provides the control methods for activities. An activity can be periodic, non periodic, event driven or any activity object which can be started, stopped and be queried for their state and (optional) period.
It is complementary to the RunnableInterface, which defines the methods for the functionality that is executed.
- See also:
- RunnableInterface
Definition at line 62 of file ActivityInterface.hpp.
Member Function Documentation
| void RTT::ActivityInterface::disableRun | ( | RunnableInterface * | caller | ) | [inline, protected] |
This method is only meant for RunnableInterface (ie runner) in order to inform the ActivityInterface it should no longer be used.
run(0) can not be used in this case because it would recurse.
Definition at line 73 of file ActivityInterface.hpp.
| virtual bool RTT::ActivityInterface::execute | ( | ) | [pure 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().
- Return values:
-
true When this->isActive() and the implementation allows external executes. false When !this->isActive() or the implementation does not allow external updating.
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, RTT::SimulationActivity, and RTT::SlaveActivity.
| virtual Seconds RTT::ActivityInterface::getPeriod | ( | ) | const [pure virtual] |
Get the periodicity of this activity in Seconds.
- Returns:
- The execution period of this activity (zero if !this->isPeriodic() ).
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
| virtual bool RTT::ActivityInterface::isActive | ( | ) | const [pure 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.
- Returns:
- true if it is active, false otherwise
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
| virtual bool RTT::ActivityInterface::isPeriodic | ( | ) | const [pure 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().
- Returns:
- true if periodic.
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
| virtual bool RTT::ActivityInterface::isRunning | ( | ) | const [pure 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.
- Returns:
- true if it is running, false otherwise
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
| virtual bool RTT::ActivityInterface::run | ( | RunnableInterface * | r | ) | [virtual] |
Run exclusively this RunnableInterface.
- Precondition:
- this->isRunning() == false
- Parameters:
-
r The RunnableInterface to run exclusively.
- Returns:
- true if succeeded, false otherwise
Referenced by RTT::NonPeriodicActivity::run().
| virtual bool RTT::ActivityInterface::start | ( | ) | [pure 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.
- See also:
- isPeriodic()
- Returns:
- true if the activity is started, false otherwise
Implemented in RTT::Activity, RTT::EventDrivenActivity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, RTT::SimulationActivity, and RTT::SlaveActivity.
| virtual bool RTT::ActivityInterface::stop | ( | ) | [pure 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.
- See also:
- isPeriodic()
- Returns:
- true if the activity is stopped, false otherwise
Implemented in RTT::Activity, RTT::EventDrivenActivity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
| virtual OS::ThreadInterface* RTT::ActivityInterface::thread | ( | ) | [pure virtual] |
Returns a pointer to the thread which will run this activity.
Will not be null.
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
| virtual bool RTT::ActivityInterface::trigger | ( | ) | [pure 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.
- Return values:
-
true When this->isActive() and the implementation allows external triggers. false When !this->isActive() or the implementation does not allow external triggering.
Implemented in RTT::Activity, RTT::NonPeriodicActivity, RTT::PeriodicActivity, RTT::SequentialActivity, and RTT::SlaveActivity.
The documentation for this class was generated from the following file:
