Fawkes API  Fawkes Development Version
RoombaJoystickThread Class Reference

Roomba joystick control thread. More...

#include "roombajoy_thread.h"

Inheritance diagram for RoombaJoystickThread:

List of all members.

Public Member Functions

 RoombaJoystickThread ()
 Constructor.
virtual void init ()
 Initialize the thread.
virtual void finalize ()
 Finalize the thread.
virtual void loop ()
 Code to execute in the thread.

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging.

Detailed Description

Roomba joystick control thread.

Read joystick information from the blackboard and transform it into commands for the Roomba plugin. This is for demonstration purposes, but really this should be solved at the skill and agent levels (easy to spot because this thread is also hooked in at the skill hook).

Author:
Tim Niemueller

Constructor & Destructor Documentation

RoombaJoystickThread::RoombaJoystickThread ( )

Constructor.

Definition at line 54 of file roombajoy_thread.cpp.


Member Function Documentation

void RoombaJoystickThread::finalize ( ) [virtual]

Finalize the thread.

This method is executed just before the thread is canceled and destroyed. It is always preceeded by a call to prepare_finalize(). If this is not the case this is a failure. The condition can be checked with the boolean variable finalize_prepared.

This method is meant to be used in conjunction with aspects and to cover thread inter-dependencies. This routine MUST bring the thread into a safe state such that it may be canceled and destroyed afterwards. If there is any reason that this cannot happen make your prepare_finalize() reports so.

This method is called by the thread manager just before the thread is being cancelled. Here you can do whatever steps are necessary just before the thread is cancelled. Note that you thread is still running and might be in the middle of a loop, so it is not a good place to give up on all resources used. Mind segmentation faults that could happen. Protect the area with a mutex that you lock at the beginning of your loop and free in the end, and that you lock at the beginning of finalize and then never unlock. Also not that the finalization may be canceled afterwards. The next thing that happens is that either the thread is canceled and destroyed or that the finalization is canceled and the thread has to run again.

Finalize is called on a thread just before it is deleted. It is guaranteed to be called on a fully initialized thread (if no exception is thrown in init()) (this guarantee holds in the Fawkes framework).

The default implementation does nothing besides throwing an exception if prepare_finalize() has not been called.

Exceptions:
Exceptionthrown if prepare_finalize() has not been called.
See also:
prepare_finalize()
cancel_finalize()

Reimplemented from fawkes::Thread.

Definition at line 114 of file roombajoy_thread.cpp.

References fawkes::BlackBoardAspect::blackboard, and fawkes::BlackBoard::close().

void RoombaJoystickThread::init ( ) [virtual]

Initialize the thread.

This method is meant to be used in conjunction with aspects. Some parts of the initialization may only happen after some aspect of the thread has been initialized. Implement the init method with these actions. It is guaranteed to be called just after all aspects have been initialized and only once in the lifetime of the thread. Throw an exception if any problem occurs and the thread should not run.

Just because your init() routine suceeds and everything looks fine for this thread does not automatically imply that it will run. If it belongs to a group of threads in a ThreadList and any of the other threads fail to initialize then no thread from this group is run and thus this thread will never run. In that situation finalize() is called for this very instance, prepare_finalize() however is not called.

See also:
Fawkes Thread Aspects

Reimplemented from fawkes::Thread.

Definition at line 62 of file roombajoy_thread.cpp.

References fawkes::ConfigurableAspect::config, fawkes::Configuration::get_uint(), fawkes::BlackBoardAspect::blackboard, fawkes::BlackBoard::open_for_reading(), fawkes::BlackBoard::close(), fawkes::JoystickInterface::maxlenof_axis(), fawkes::LoggingAspect::logger, fawkes::Logger::log_warn(), and fawkes::Thread::name().

virtual void RoombaJoystickThread::run ( ) [inline, protected, virtual]

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 58 of file roombajoy_thread.h.


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