blip  0.1
TimerEvent Class Reference

A timer event. More...

#include <TimerEvent.hpp>

Inheritance diagram for TimerEvent:

Public Types

enum  Type { Type_Key, Type_Motion, Type_Sensor, Type_Timer }
 Event types. More...
 

Public Member Functions

virtual ~TimerEvent ()
 Destructor. More...
 
TimerID getTimerID () const
 Get the ID of this timer. More...
 
virtual time_ms_t getEventTime () const
 Get the time at which this event occurred. More...
 
uint_t getFireCount () const
 Get the number of times that this TimerEvent has been fired. More...
 
Type getType () const
 Get the event type. More...
 

Detailed Description

A timer event.

Timer events can be scheduled using a TimerManager.

Author
Mark Lindner

Member Enumeration Documentation

◆ Type

enum Type
inherited

Event types.

Enumerator
Type_Key 

Key input events.

Type_Motion 

Motion input events.

Type_Sensor 

Sensor events.

Type_Timer 

Timer events.

Constructor & Destructor Documentation

◆ ~TimerEvent()

~TimerEvent ( )
virtual

Destructor.

Member Function Documentation

◆ getEventTime()

virtual time_ms_t getEventTime ( ) const
inlinevirtual

Get the time at which this event occurred.

Implements Event.

◆ getFireCount()

uint_t getFireCount ( ) const
inline

Get the number of times that this TimerEvent has been fired.

◆ getTimerID()

TimerID getTimerID ( ) const
inline

Get the ID of this timer.

◆ getType()

Type getType ( ) const
inlineinherited

Get the event type.


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