#include <Consumer.hpp>
Public Member Functions | |
| Consumer (std::string const &name="data::Consumer", TaskCore::TaskState initial_state=Stopped) | |
| bool | startHook () |
| The following lines are template definitions for the various state machine. | |
| void | stopHook () |
| void | updateHook () |
Protected Attributes | |
| std::ostream * | outfile |
Friends | |
| class | ConsumerBase |
Definition at line 8 of file data_triggered/tasks/Consumer.hpp.
| Consumer::Consumer | ( | std::string const & | name = "data::Consumer", |
| TaskCore::TaskState | initial_state = Stopped |
||
| ) |
Definition at line 8 of file data_triggered/tasks/Consumer.cpp.
| bool Consumer::startHook | ( | ) |
The following lines are template definitions for the various state machine.
This hook is called by Orocos when the state machine transitions from PreOperational to Stopped. If it returns false, then the component will stay in PreOperational. Otherwise, it goes into Stopped.
It is meaningful only if the #needs_configuration has been specified in the task context definition with (for example):
task_context "TaskName" do needs_configuration ... end This hook is called by Orocos when the state machine transitions from Stopped to Running. If it returns false, then the component will stay in Stopped. Otherwise, it goes into Running and updateHook() will be called.
Definition at line 16 of file data_triggered/tasks/Consumer.cpp.
| void Consumer::stopHook | ( | ) |
This hook is called by Orocos when the component is in the RunTimeError state, at each activity step. See the discussion in updateHook() about triggering options.
Call recovered() to go back in the Runtime state. This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.
Definition at line 36 of file data_triggered/tasks/Consumer.cpp.
| void Consumer::updateHook | ( | ) |
This hook is called by Orocos when the component is in the Running state, at each activity step. Here, the activity gives the "ticks" when the hook should be called. See README.txt for different triggering options.
The warning(), error() and fatal() calls, when called in this hook, allow to get into the associated RunTimeWarning, RunTimeError and FatalError states.
In the first case, updateHook() is still called, and recovered() allows you to go back into the Running state. In the second case, the errorHook() will be called instead of updateHook() and in the third case the component is stopped and resetError() needs to be called before starting it again.
The updated_ports argument is the set of ports that have triggered this call. If the trigger is caused by something different (for instance, a periodic update), then this set is empty.
Definition at line 21 of file data_triggered/tasks/Consumer.cpp.
friend class ConsumerBase [friend] |
Definition at line 10 of file data_triggered/tasks/Consumer.hpp.
std::ostream* data::Consumer::outfile [protected] |
Definition at line 12 of file data_triggered/tasks/Consumer.hpp.