class TimedThread

Timed Thread. More...

Contains pure virtuals
Full nameCoral::TimedThread
Definition#include <timedthread.h>
InheritsCoral::SingleTimerThread [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

This abstract class realizes a timed thread based on MultiTimerThread. The user of this class has to implement timerEvent(). Inaccurate system timers are corrected by calling user's timerEvent() implementation multiple times if necessary. This feature can be modified by setTimerCorrection (Default is on at a maximum of 10 calls).

See also: Thread

 TimedThread (const card64 usec, const char* name = "TimedThread", const cardinal flags = TF_CancelDeferred)

TimedThread

Constructor. A new timed thread with a given interval will be created but *not* started! To start the new thread, call start(). The interval gives the time for the interval in microseconds, the virtual function timerEvent() is called. The default timer correction is set to 10. See setTimerCorrection() for more information on timer correction. The first call of timerEvent() will be made immediately, if the fast start option is set (default). Otherwise it will be made after the given interval.

Parameters:
usecInterval in microseconds.
nameThread name.
flagsThread flags.

See also: Thread#start, timerEvent, Thread#Thread, setTimerCorrection, setFastStart

 ~TimedThread ()

~TimedThread

Destructor.

inline card64  getInterval ()

getInterval

[const]

Get timed thread's interval.

Returns: Interval in microseconds.

inline void  setInterval (const card64 usec)

setInterval

Set timed thread's interval.

Parameters:
usecInterval in microseconds.

inline void  setNextAction (const card64 usec = 0, const card64 callLimit = 1)

setNextAction

Like setInterval(), but disabling FastStart first. This method can be used e.g. for a single shot timer.

Parameters:
usecTime to next invokation (0 = immediately).
callLimitCall count limit (0 for infinite, default: 1).

See also: setInterval

inline void  setNextActionAbs (const card64 timeStamp = 0, const card64 callLimit = 1)

setNextActionAbs

Like setNextAction(), but the time stamp of the next invokation is given as absolute time (microseconds since January 01, 1970).

Parameters:
usecTime to next invokation (0 = immediately).
callLimitCall count limit (0 for infinite, default: 1).

See also: setInterval, setNextAction

inline cardinal  getTimerCorrection ()

getTimerCorrection

[const]

Get maxCorrection value for inaccurate system timer.

Returns: true, if activated; false if not.

See also: setTimerCorrection

inline void  setTimerCorrection (const cardinal maxCorrection = 0)

setTimerCorrection

Set correction of inaccurate system timer to given value. This on will cause the timerEvent() function to be called a maximum of maxCorrection times, if the total number of calls is lower than the calculated number of times the function should have been called. If the number of correction calls is higher than maxCorrection, *no* correction will be done! Default is 0, which turns correction off.

Parameters:
oftrue to activate correction; false to deactivate.

inline void  leaveCorrectionLoop ()

leaveCorrectionLoop

Leave timer correction loop: If the thread is in a timer correction loop, the loop will be finished after the current timerEvent() call returns.

inline void  setFastStart (const bool on)

setFastStart

Set fast start option: If false, the first call of timerEvent() will be made *after* the given interval; otherwise it will be made immediately. The default is true.

Parameters:
ontrue, to set option; false otherwise.

inline bool  getFastStart ()

getFastStart

[const]

Get fast start option: If false, the first call of timerEvent() will be made *after* the given interval; otherwise it will be made immediately.

Returns: true, if option is set; false otherwise.

void  timerEvent ()

timerEvent

[protected pure virtual]

The virtual timerEvent() method, which contains the timed thread's implementation. It has to be implemented by classes, which inherit TimedThread. This method is called regularly with the given interval.