okapi::AbstractRate Class Reference

#include <abstractRate.hpp>

Inheritance diagram for okapi::AbstractRate:

Public Member Functions
virtual	~AbstractRate ()
virtual void	delay (QFrequency ihz)=0
	Delay the current task such that it runs at the given frequency.
virtual void	delayUntil (QTime itime)=0
	Delay the current task until itime has passed.
virtual void	delayUntil (uint32_t ims)=0
	Delay the current task until ims milliseconds have passed.

Detailed Description

Definition at line 13 of file abstractRate.hpp.

Constructor & Destructor Documentation

~AbstractRate()

virtual okapi::AbstractRate::~AbstractRate ( )

virtual

Member Function Documentation

delay()

virtual void okapi::AbstractRate::delay ( QFrequency  ihz )

pure virtual

Delay the current task such that it runs at the given frequency.

The first delay will run for 1000/(ihz). Subsequent delays will adjust according to the previous runtime of the task.

Parameters

ihz	the frequency

Implemented in okapi::Rate.

delayUntil() [1/2]

virtual void okapi::AbstractRate::delayUntil ( QTime  itime )

pure virtual

Delay the current task until itime has passed.

This method can be used by periodic tasks to ensure a consistent execution frequency.

Parameters

itime

the time period

Implemented in okapi::Rate.

delayUntil() [2/2]

virtual void okapi::AbstractRate::delayUntil ( uint32_t  ims )

pure virtual

Delay the current task until ims milliseconds have passed.

This method can be used by periodic tasks to ensure a consistent execution frequency.

Parameters

ims	the time period

Implemented in okapi::Rate.

---

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

• include/okapi/api/util/abstractRate.hpp