NetBurner 3.5.0
PDF Version
 
DelayObject Class Reference

Microsecond Delay Class. More...

#include <HiResDelay.h>

Public Member Functions

 DelayObject (int Timer=FIRST_UNUSED_TIMER)
 Microsecond Delay Timer Constructor.
 
void DelayUsec (uint32_t usec)
 Microsecond Delay Timer.
 
bool valid ()
 Verify a valid delay object was constructed.
 

Detailed Description

Microsecond Delay Class.

Creates a high resolution microsecond timer object by allocating one a free processor system timer. Once the delay has expired, the system timer is releaed back to the free pool.

Example Usage:

static DelayObject myHiResDelay; // Create the object
myHiDrsDelay.DelayUsec(100); // Delay 100 us
myHiDrsDelay.DelayUsec(200); // Delay 200 us
myHiDrsDelay.DelayUsec(300); // Delay 300 us
Microsecond Delay Class.
Definition HiResDelay.h:60
void DelayUsec(uint32_t usec)
Microsecond Delay Timer.
See also
Interval Timer
Stopwatch Timer
OSTimeDly()

Constructor & Destructor Documentation

◆ DelayObject()

DelayObject::DelayObject ( int Timer = FIRST_UNUSED_TIMER)

Microsecond Delay Timer Constructor.

Parameters
TimerOptional parameter to select a specific time. Recommend use is the to not specify a timer so the first free timer will be used.

Member Function Documentation

◆ DelayUsec()

void DelayObject::DelayUsec ( uint32_t usec)

Microsecond Delay Timer.

Parameters
usecThe number of microseconds to delay

◆ valid()

bool DelayObject::valid ( )
inline

Verify a valid delay object was constructed.

Return values
True- A timer was correctly allocated and initialized
False- No free timers were available

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