Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
KatanaCalibrationThread Class Reference

Katana calibration thread. More...

#include "calib_thread.h"

Inheritance diagram for KatanaCalibrationThread:

List of all members.

Public Member Functions

 KatanaCalibrationThread (fawkes::RefPtr< fawkes::KatanaController > katana, fawkes::Logger *logger)
 Constructor.
virtual void once ()
 Execute an action exactly once.
- Public Member Functions inherited from KatanaMotionThread
 KatanaMotionThread (const char *thread_name, fawkes::RefPtr< fawkes::KatanaController > katana, fawkes::Logger *logger)
 Constructor.
bool finished () const
 Did the motion finish already?
virtual void reset ()
 Reset for next execution.
unsigned int error_code () const
 Error code.
- Public Member Functions inherited from fawkes::Thread
virtual ~Thread ()
 Virtual destructor.
virtual void init ()
 Initialize the thread.
bool prepare_finalize ()
 Prepare finalization.
virtual bool prepare_finalize_user ()
 Prepare finalization user implementation.
virtual void finalize ()
 Finalize the thread.
void cancel_finalize ()
 Cancel finalization.
void start (bool wait=true)
 Call this method to start the thread.
void cancel ()
 Cancel a thread.
void join ()
 Join the thread.
void detach ()
 Detach the thread.
void kill (int sig)
 Send signal to a thread.
bool operator== (const Thread &thread)
 Check if two threads are the same.
void wakeup ()
 Wake up thread.
void wakeup (Barrier *barrier)
 Wake up thread and wait for barrier afterwards.
void wait_loop_done ()
 Wait for the current loop iteration to finish.
OpMode opmode () const
 Get operation mode.
pthread_t thread_id () const
 Get ID of thread.
bool started () const
 Check if thread has been started.
bool cancelled () const
 Check if thread has been cancelled.
bool detached () const
 Check if thread has been detached.
bool running () const
 Check if the thread is running.
bool waiting () const
 Check if thread is currently waiting for wakeup.
const char * name () const
 Get name of thread.
void set_flags (uint32_t flags)
 Set all flags in one go.
void set_flag (uint32_t flag)
 Set flag for the thread.
void unset_flag (uint32_t flag)
 Unset flag.
bool flagged_bad () const
 Check if FLAG_BAD was set.
void set_delete_on_exit (bool del)
 Set whether the thread should be deleted on exit.
void set_prepfin_hold (bool hold)
 Hold prepare_finalize().
void add_notification_listener (ThreadNotificationListener *notification_listener)
 Add notification listener.
void remove_notification_listener (ThreadNotificationListener *notification_listener)
 Remove notification listener.

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from KatanaMotionThread
fawkes::RefPtr
< fawkes::KatanaController
_katana
 Katana object for interaction with the arm.
bool _finished
 Set to true when motion is finished, to false on reset.
fawkes::Logger_logger
 Logger.
unsigned int _error_code
 Set to the desired error code on error.
- Protected Attributes inherited from fawkes::Thread
bool finalize_prepared
 True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise.
Mutexloop_mutex
 Mutex that is used to protect a call to loop().
Mutexloopinterrupt_antistarve_mutex
 Mutex to avoid starvation when trying to lock loop_mutex.

Detailed Description

Katana calibration thread.

This thread calibrates the arm when started and is finished when the calibration is done.

Author:
Tim Niemueller

Definition at line 28 of file calib_thread.h.


Constructor & Destructor Documentation

KatanaCalibrationThread::KatanaCalibrationThread ( fawkes::RefPtr< fawkes::KatanaController katana,
fawkes::Logger logger 
)

Constructor.

Parameters:
katanakatana controller base class
loggerlogger

Definition at line 37 of file calib_thread.cpp.


Member Function Documentation

void KatanaCalibrationThread::once ( )
virtual

Execute an action exactly once.

This code is executed once and only once right after the thread is started before loop() is called. This is useful if you want to implement an one-shot background job. Just implement once() and leave once() untouched. Start the thread and detach it and it will just do its job and then die automatically. If you use set_delete_on_exit(true) even the Thread instance will be automatically deleted.

Reimplemented from fawkes::Thread.

Definition at line 44 of file calib_thread.cpp.

References KatanaMotionThread::_error_code, KatanaMotionThread::_finished, KatanaMotionThread::_katana, KatanaMotionThread::_logger, fawkes::KatanaController::calibrate(), fawkes::KatanaInterface::ERROR_CMD_START_FAILED, fawkes::Logger::log_debug(), fawkes::Logger::log_warn(), fawkes::Thread::name(), and fawkes::Exception::what().

virtual void KatanaCalibrationThread::run ( )
inlineprotectedvirtual

Stub to see name in backtrace for easier debugging.

See also:
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 36 of file calib_thread.h.


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