Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
icl_core::thread::PeriodicThread Class Reference

#include <PeriodicThread.h>

Inheritance diagram for icl_core::thread::PeriodicThread:
Inheritance graph

List of all members.

Public Member Functions

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 ()

Protected Member Functions

void waitPeriod ()

Private Member Functions

virtual void makePeriodic ()

Private Attributes


Detailed Description

Implements a periodic thread.

The thread's main loop can wait until the configured period has elapsed by calling waitPeriod().

Definition at line 55 of file PeriodicThread.h.

Constructor & Destructor Documentation

icl_core::thread::PeriodicThread::PeriodicThread ( const icl_core::String description,
const icl_core::TimeSpan period,
ThreadPriority  priority = 0 

Initializes a periodic thread.

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

Definition at line 50 of file PeriodicThread.cpp.

Deletes a periodic thread.

Definition at line 106 of file PeriodicThread.cpp.

Member Function Documentation

Makes the thread periodic.

This function is overridden in PeriodicThread.

Reimplemented from icl_core::thread::Thread.

Definition at line 181 of file PeriodicThread.cpp.

Returns the thread's period.

Definition at line 111 of file PeriodicThread.cpp.

Changes the thread's period.

true on success, false if the period could not be changed.

Definition at line 116 of file PeriodicThread.cpp.

Sleep until the end of the current period.

Definition at line 143 of file PeriodicThread.cpp.

Member Data Documentation

Reimplemented from icl_core::thread::Thread.

Definition at line 121 of file PeriodicThread.h.

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

autogenerated on Thu Jun 6 2019 20:22:27