Public Member Functions | Public Attributes | Private Member Functions
SickThread< T, M > Class Template Reference

Wrapper class for posix threads. More...

#include <SickThread.hpp>

Inheritance diagram for SickThread< T, M >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void join ()
 SickThread ()
virtual ~SickThread ()

Public Attributes

bool m_threadShouldRun

Private Member Functions

void thread_entry ()

Detailed Description

template<typename T, void(T::*)(bool &, UINT16 &) M>
class SickThread< T, M >

Wrapper class for posix threads.

Usage: Using object must create an instance of this class, and then call start() with its callback function as argument (see start() for more details). To stop the thread execution, call stop().

Setting the parameter m_beVerbose to true (e.g. via enableVerboseDebugOutput in function start()) will turn on *very* verbose output that should be useful for debugging.

The thread callback function itself has 2 parameters:

endThisThread: A bool flag that may be set by the callback function to "false" in case the thread function decides this thread needs to end.

sleepTimeMs: The sleep time, in ms, that will be spent between subsequent calls to the callback function. Default is 10 ms, but other times may be set. Note that not all operating systems may be able to schedule very short sleep times.

Definition at line 80 of file SickThread.hpp.


Constructor & Destructor Documentation

template<typename T, void(T::*)(bool &, UINT16 &) M>
SickThread< T, M >::SickThread ( ) [inline]

Definition at line 105 of file SickThread.hpp.

template<typename T, void(T::*)(bool &, UINT16 &) M>
virtual SickThread< T, M >::~SickThread ( ) [inline, virtual]

Definition at line 106 of file SickThread.hpp.


Member Function Documentation

template<typename T, void(T::*)(bool &, UINT16 &) M>
void SickThread< T, M >::join ( ) [inline]

Reimplemented from ThreadWrapperBase.

Definition at line 99 of file SickThread.hpp.

template<typename T, void(T::*)(bool &, UINT16 &) M>
void SickThread< T, M >::thread_entry ( ) [inline, private, virtual]

Implements ThreadWrapperBase.

Definition at line 82 of file SickThread.hpp.


Member Data Documentation

template<typename T, void(T::*)(bool &, UINT16 &) M>
bool SickThread< T, M >::m_threadShouldRun

Definition at line 106 of file SickThread.hpp.


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


libsick_ldmrs
Author(s): SICK AG , Martin Günther , Jochen Sprickerhof
autogenerated on Thu Jun 6 2019 21:02:36