Fawkes API  Fawkes Development Version
NaoQiLedThread Class Reference

Thread to synchronize with LEDs. More...

#include "led_thread.h"

Inheritance diagram for NaoQiLedThread:

List of all members.

Public Member Functions

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

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging.
bool bb_interface_message_received (fawkes::Interface *interface, fawkes::Message *message) throw ()
 BlackBoard message received notification.

Detailed Description

Thread to synchronize with LEDs.

This thread registered for data changed events to a specified LED and updates the blackboard interface. It also processes actuation commands. if there is a reader for any of the high frequency interfaces. It is also responsible for processing incoming commands.


Constructor & Destructor Documentation

NaoQiLedThread::NaoQiLedThread ( )

Constructor.

Definition at line 88 of file led_thread.cpp.

NaoQiLedThread::~NaoQiLedThread ( ) [virtual]

Destructor.

Definition at line 97 of file led_thread.cpp.


Member Function Documentation

bool NaoQiLedThread::bb_interface_message_received ( fawkes::Interface interface,
fawkes::Message message 
) throw () [protected, virtual]

BlackBoard message received notification.

This is called whenever a message is received for this interface. This method is only called for writing instances of an interface, never on reading instances. If you have processed the message already, you can order that the message is not enqueued by returning false. Returning true will enqueue the message as usual. You should only do very (very!) quick tasks directly in this method, as it is out of the regular thread context and can harm performance of other plugins and the system as a whole. Note that if you decide to return false the message is not referenced. If you want to keep it longer you have to ref() it by yourself. An example where this would really make sense is a "STOP" message for the motor, which needs to be processed ASAP and maybe even waiting a couple of miliseconds for the next cycle is not acceptable.

Parameters:
interfaceinterface instance that you supplied to bbil_add_message_interface()
messagethe message that was sent
Returns:
true to get the message enqueued afterwards as usual, false to prevent queuing of the message.

Reimplemented from fawkes::BlackBoardInterfaceListener.

Definition at line 394 of file led_thread.cpp.

References fawkes::LedInterface::SetIntensityMessage::intensity(), and fawkes::LedInterface::SetIntensityMessage::time_sec().

void NaoQiLedThread::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 349 of file led_thread.cpp.

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

void NaoQiLedThread::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 102 of file led_thread.cpp.

References fawkes::ConfigurableAspect::config, fawkes::Configuration::get_bool(), fawkes::NaoQiAspect::naoqi_broker, fawkes::BlackBoardAspect::blackboard, fawkes::BlackBoard::open_for_reading(), fawkes::Interface::has_writer(), fawkes::BlackBoard::close(), fawkes::Interface::read(), fawkes::NaoJointPositionInterface::robot_type(), fawkes::BlackBoard::open_for_writing(), fawkes::BlackBoardInterfaceListener::bbil_add_message_interface(), and fawkes::BlackBoard::register_listener().

void NaoQiLedThread::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 367 of file led_thread.cpp.

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

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 63 of file led_thread.h.


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