Public Member Functions | Private Member Functions | Private Attributes | List of all members
icl_core::dispatch::PeriodicDispatchThread Class Reference

Dispatches the contained operations periodically. More...

#include <PeriodicDispatchThread.h>

Inheritance diagram for icl_core::dispatch::PeriodicDispatchThread:
Inheritance graph
[legend]

Public Member Functions

void addOperation (Operation *op)
 Add the operation op to the dispatch queue. More...
 
 PeriodicDispatchThread (icl_core::String const &description, icl_core::TimeSpan const &period, ThreadPriority priority=0)
 
virtual ~PeriodicDispatchThread ()
 Destroys a periodic dispatch thread. More...
 
- Public Member Functions inherited from icl_core::thread::PeriodicThread
icl_core::TimeSpan period () const
 
 PeriodicThread (const icl_core::String &description, const icl_core::TimeSpan &period, ThreadPriority priority=0)
 
bool setPeriod (const icl_core::TimeSpan &period)
 
virtual ~PeriodicThread ()
 
- Public Member Functions inherited from icl_core::thread::Thread
void cancel ()
 
bool checkHardRealtime ()
 
bool execute () const
 
bool executesHardRealtime () const
 
icl_core::String getDescription () const
 
bool isHardRealtime () const
 
void join ()
 
virtual void onStop ()
 
icl_core::ThreadPriority priority () const
 
bool running () const
 
void setDescription (const icl_core::String &description)
 
bool setHardRealtime (bool hard_realtime=true)
 
bool setPriority (icl_core::ThreadPriority priority)
 
bool start ()
 
void stop ()
 
 Thread (const icl_core::String &description, icl_core::ThreadPriority priority=0)
 
icl_core::ThreadId threadId () const
 
const char * threadInfo () const
 
bool threadSelf () const
 
bool wait ()
 
bool wait (const icl_core::TimeStamp &timeout)
 
bool wait (const icl_core::TimeSpan &timeout)
 
virtual ~Thread ()
 

Private Member Functions

virtual void run ()
 Perform the periodic dispatching. More...
 

Private Attributes

icl_core::List< Operation * > m_dispatch_queue
 

Additional Inherited Members

- Static Public Member Functions inherited from icl_core::thread::Thread
static icl_core::ThreadId selfId ()
 
- Protected Member Functions inherited from icl_core::thread::PeriodicThread
void waitPeriod ()
 
- Protected Member Functions inherited from icl_core::Noncopyable
 Noncopyable ()
 
virtual ~Noncopyable ()
 

Detailed Description

Dispatches the contained operations periodically.

Definition at line 36 of file PeriodicDispatchThread.h.

Constructor & Destructor Documentation

icl_core::dispatch::PeriodicDispatchThread::PeriodicDispatchThread ( icl_core::String const &  description,
icl_core::TimeSpan const &  period,
ThreadPriority  priority = 0 
)

Initializes a periodic dispatch thread.

Parameters
descriptionThe thread's description.
periodThe relative period after which the thread is cyclically woken up.
priorityThe thread's priority.

Definition at line 32 of file PeriodicDispatchThread.cpp.

icl_core::dispatch::PeriodicDispatchThread::~PeriodicDispatchThread ( )
virtual

Destroys a periodic dispatch thread.

Definition at line 39 of file PeriodicDispatchThread.cpp.

Member Function Documentation

void icl_core::dispatch::PeriodicDispatchThread::addOperation ( Operation op)

Add the operation op to the dispatch queue.

Definition at line 45 of file PeriodicDispatchThread.cpp.

void icl_core::dispatch::PeriodicDispatchThread::run ( )
privatevirtual

Perform the periodic dispatching.

Implements icl_core::thread::Thread.

Definition at line 50 of file PeriodicDispatchThread.cpp.

Member Data Documentation

icl_core::List<Operation*> icl_core::dispatch::PeriodicDispatchThread::m_dispatch_queue
private

Definition at line 58 of file PeriodicDispatchThread.h.


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


fzi_icl_core
Author(s):
autogenerated on Mon Jun 10 2019 13:17:59