Fawkes API  Fawkes Development Version
FvRetrieverThread Class Reference

FireVision retriever thread. More...

#include "retriever_thread.h"

Inheritance diagram for FvRetrieverThread:

List of all members.

Public Member Functions

 FvRetrieverThread (const char *camera_string, const char *id)
 Constructor.
virtual ~FvRetrieverThread ()
 Destructor.
virtual void init ()
 Initialize the thread.
virtual void finalize ()
 Finalize the thread.
virtual void loop ()
 Thread loop.

Protected Member Functions

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

Detailed Description

FireVision retriever thread.

This implements the functionality of the FvRetrieverPlugin.

Author:
Tim Niemueller

Constructor & Destructor Documentation

FvRetrieverThread::FvRetrieverThread ( const char *  camera_string,
const char *  id 
)

Constructor.

Parameters:
camera_stringcamera argument string for camera to open
idID used to form thread name (FvRetrieverThread_[ID]) and shared memory image segment ID (retriever_[ID]).

Definition at line 49 of file retriever_thread.cpp.

References fawkes::Thread::set_name().

FvRetrieverThread::~FvRetrieverThread ( ) [virtual]

Destructor.

Definition at line 61 of file retriever_thread.cpp.


Member Function Documentation

void FvRetrieverThread::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 150 of file retriever_thread.cpp.

References fawkes::LoggingAspect::logger, fawkes::Logger::log_debug(), fawkes::Thread::name(), fawkes::VisionAspect::vision_master, and firevision::VisionMaster::unregister_thread().

void FvRetrieverThread::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 69 of file retriever_thread.cpp.

References fawkes::LoggingAspect::logger, fawkes::Logger::log_debug(), fawkes::Thread::name(), fawkes::VisionAspect::vision_master, firevision::VisionMaster::register_for_camera(), fawkes::Exception::append(), firevision::Camera::colorspace(), firevision::Camera::pixel_width(), firevision::Camera::pixel_height(), fawkes::SharedMemory::is_valid(), fawkes::ConfigurableAspect::config, fawkes::Configuration::get_bool(), fawkes::Logger::log_info(), fawkes::Configuration::get_string(), firevision::SeqWriter::set_path(), firevision::SeqWriter::set_dimensions(), firevision::SeqWriter::set_colorspace(), fawkes::TimeTracker::add_class(), firevision::ColorModelLookupTable::get_colormap(), firevision::YuvColormap::set(), and firevision::Camera::capture_time().

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

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 57 of file retriever_thread.h.


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