gps
Public Member Functions | Protected Attributes | Friends | List of all members
gps::GPSDTask Class Reference

#include <GPSDTask.hpp>

Inheritance diagram for gps::GPSDTask:

Public Member Functions

 GPSDTask (std::string const &name="gps::GPSDTask")
 
 ~GPSDTask ()
 
bool configureHook ()
 The following lines are template definitions for the various state machine. More...
 
bool startHook ()
 
void updateHook ()
 
void cleanupHook ()
 

Protected Attributes

gpsmm * gpsd_daemon
 
int counter_waiting
 
int counter_polling
 

Friends

class GPSDTaskBase
 

Constructor & Destructor Documentation

GPSDTask::GPSDTask ( std::string const &  name = "gps::GPSDTask")
GPSDTask::~GPSDTask ( )

Member Function Documentation

void GPSDTask::cleanupHook ( )

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.

bool GPSDTask::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

bool GPSDTask::startHook ( )

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.

void GPSDTask::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.

Friends And Related Function Documentation

friend class GPSDTaskBase
friend

Member Data Documentation

int gps::GPSDTask::counter_polling
protected
int gps::GPSDTask::counter_waiting
protected
gpsmm* gps::GPSDTask::gpsd_daemon
protected

The documentation for this class was generated from the following files: