OpenZWave Library  1.6.953
Public Member Functions | List of all members
OpenZWave::Internal::Timer Class Reference

Timer SubClass for automatically registering/unregistering Timer Callbacks if the instance goes out of scope. More...

#include <TimerThread.h>

+ Inheritance diagram for OpenZWave::Internal::Timer:

Public Member Functions

 Timer (Driver *_driver)
 Constructor with the _driver this instance is associated with. More...
 
 Timer ()
 Default Constructor. More...
 
 ~Timer ()
 Destructor. More...
 
TimerThread::TimerEventEntryTimerSetEvent (int32 _milliseconds, TimerThread::TimerCallback _callback, uint32 id)
 Schedule an event. More...
 
void TimerDelEvents ()
 Delete All Events registered to this instance. More...
 
void TimerDelEvent (TimerThread::TimerEventEntry *te)
 Delete a Specific Event Registered to this instance. More...
 
void TimerDelEvent (uint32 id)
 Delete a Specific Event Registered to this instance. More...
 
void SetDriver (Driver *_driver)
 Register the Driver Associated with this Instance. More...
 
void TimerFireEvent (TimerThread::TimerEventEntry *te)
 Called From the TimerThread Class to execute a callback. More...
 

Detailed Description

Timer SubClass for automatically registering/unregistering Timer Callbacks if the instance goes out of scope.

Constructor & Destructor Documentation

◆ Timer() [1/2]

OpenZWave::Internal::Timer::Timer ( Driver _driver)

Constructor with the _driver this instance is associated with.

Parameters
_driverThe Driver that this instance is associated with

◆ Timer() [2/2]

OpenZWave::Internal::Timer::Timer ( )

Default Constructor.

◆ ~Timer()

OpenZWave::Internal::Timer::~Timer ( )

Destructor.

Member Function Documentation

◆ SetDriver()

void OpenZWave::Internal::Timer::SetDriver ( Driver _driver)

Register the Driver Associated with this Instance.

Parameters
_driverThe Driver

◆ TimerDelEvent() [1/2]

void OpenZWave::Internal::Timer::TimerDelEvent ( TimerThread::TimerEventEntry te)

Delete a Specific Event Registered to this instance.

Parameters
teThe TimerEventEntry Struct that was returned when Setting a Event

◆ TimerDelEvent() [2/2]

void OpenZWave::Internal::Timer::TimerDelEvent ( uint32  id)

Delete a Specific Event Registered to this instance.

Parameters
idThe ID of the Timer To Delete

◆ TimerDelEvents()

void OpenZWave::Internal::Timer::TimerDelEvents ( )

Delete All Events registered to this instance.

◆ TimerFireEvent()

void OpenZWave::Internal::Timer::TimerFireEvent ( TimerThread::TimerEventEntry te)

Called From the TimerThread Class to execute a callback.

Parameters
teThe TimerEventEntry structure for the callback to execute

◆ TimerSetEvent()

TimerThread::TimerEventEntry * OpenZWave::Internal::Timer::TimerSetEvent ( int32  _milliseconds,
TimerThread::TimerCallback  _callback,
uint32  id 
)

Schedule an event.

Parameters
_millisecondsThe number of milliseconds before the event should happen
_callbackThe function to be called when the time is reached
_idThe ID of the Timer

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