Fawkes API  Fawkes Development Version
LaserFilterThread Class Reference

Laser filter thread. More...

#include "filter_thread.h"

Inheritance diagram for LaserFilterThread:

List of all members.

Public Member Functions

 LaserFilterThread (std::string &cfg_name, std::string &cfg_prefix)
 Constructor.
virtual void init ()
 Initialize the thread.
virtual void finalize ()
 Finalize the thread.
virtual void loop ()
 Code to execute in the thread.
void wait_done ()
 Wait until thread is done.
void set_wait_threads (std::list< LaserFilterThread * > &threads)
 Set threads to wait for in loop.
void set_wait_barrier (fawkes::Barrier *barrier)
 Set wait barrier.

Protected Member Functions

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

Detailed Description

Laser filter thread.

This thread integrates into the Fawkes main loop at the sensor processing hook, reads data from specified interfaces, filters it with a given cascade, and then writes it back to an interface.

Author:
Tim Niemueller

Constructor & Destructor Documentation

LaserFilterThread::LaserFilterThread ( std::string cfg_name,
std::string cfg_prefix 
)

Constructor.

Parameters:
cfg_nameshort name of configuration group
cfg_prefixconfiguration path prefix

Definition at line 62 of file filter_thread.cpp.

References fawkes::Thread::set_name().


Member Function Documentation

void LaserFilterThread::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 174 of file filter_thread.cpp.

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

void LaserFilterThread::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 75 of file filter_thread.cpp.

References fawkes::ConfigurableAspect::config, fawkes::Configuration::search(), fawkes::LoggingAspect::logger, fawkes::Logger::log_debug(), fawkes::Thread::name(), LaserDataFilter::get_out_vector(), LaserDataFilterCascade::add_filter(), LaserDataFilter::get_out_data_size(), LaserDataFilter::set_out_vector(), fawkes::BlackBoardAspect::blackboard, and fawkes::BlackBoard::close().

void LaserFilterThread::loop ( ) [virtual]

Code to execute in the thread.

Implement this method to hold the code you want to be executed continously. If you do not implement this method, the default is that the thread will exit. This is useful if you choose to only implement once().

Reimplemented from fawkes::Thread.

Definition at line 191 of file filter_thread.cpp.

References LaserDataFilter::filter(), fawkes::LoggingAspect::logger, fawkes::Logger::log_warn(), fawkes::Thread::name(), fawkes::Mutex::lock(), fawkes::WaitCondition::wake_all(), fawkes::Mutex::unlock(), and fawkes::Barrier::wait().

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

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 90 of file filter_thread.h.

void LaserFilterThread::set_wait_barrier ( fawkes::Barrier barrier)

Set wait barrier.

If there are any dependencies between laser filter threads a common barrier is used to signal the end of filtering to reset internal variables for the next loop.

Parameters:
barriercommon "end of filtering" barrier

Definition at line 445 of file filter_thread.cpp.

void LaserFilterThread::set_wait_threads ( std::list< LaserFilterThread * > &  threads)

Set threads to wait for in loop.

The threads produce data this thread depends on as input, therefore this instance has to wait for these threads to get up to date data in each loop.

Parameters:
threadsthreads this instance depends on

Definition at line 432 of file filter_thread.cpp.

void LaserFilterThread::wait_done ( )

Wait until thread is done.

This method blocks the calling thread until this instance's thread has finished filtering.

Definition at line 249 of file filter_thread.cpp.

References fawkes::Mutex::lock(), fawkes::WaitCondition::wait(), and fawkes::Mutex::unlock().


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