#include <Consumer.hpp>
Public Member Functions | |
| bool | configureHook () |
| The following lines are template definitions for the various state machine. | |
| Consumer (std::string const &name="fd::Consumer") | |
| int | getFileDescriptor () const |
| RTT::FileDescriptorActivity * | getFileDescriptorActivity () |
| void | updateHook () |
| ~Consumer () | |
Protected Attributes | |
| int | m_fd |
Friends | |
| class | ConsumerBase |
Definition at line 14 of file fd_triggered/tasks/Consumer.hpp.
| Consumer::Consumer | ( | std::string const & | name = "fd::Consumer" |
) |
Definition at line 12 of file fd_triggered/tasks/Consumer.cpp.
| Consumer::~Consumer | ( | ) |
Definition at line 25 of file fd_triggered/tasks/Consumer.cpp.
| bool Consumer::configureHook | ( | ) |
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
Definition at line 34 of file fd_triggered/tasks/Consumer.cpp.
| int fd::Consumer::getFileDescriptor | ( | ) | const |
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. This hook is called by Orocos when the state machine transitions from Stopped to PreOperational, requiring the call to configureHook() before calling start() again. This method is called after the configuration step by the FileDescriptorActivity to get the file descriptor
| RTT::FileDescriptorActivity* fd::Consumer::getFileDescriptorActivity | ( | ) |
| void Consumer::updateHook | ( | ) |
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. 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.
Definition at line 40 of file fd_triggered/tasks/Consumer.cpp.
friend class ConsumerBase [friend] |
Definition at line 16 of file fd_triggered/tasks/Consumer.hpp.
int fd::Consumer::m_fd [protected] |
Definition at line 18 of file fd_triggered/tasks/Consumer.hpp.
