Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

EventRouter::TimerEntry Struct Reference

#include <EventRouter.h>

List of all members.


Detailed Description

Contains all the information needed to maintain a timer by the EventRouter.

Definition at line 177 of file EventRouter.h.

Public Member Functions

 TimerEntry (unsigned int nxt)
 constructors an entry using the given value for next - useful for with TimerEntryPtrCmp
 TimerEntry (EventListener *e, unsigned int s, unsigned int d, bool r)
 constructs with the given values, sets next field automatically; see next
 TimerEntry (const TimerEntry &t)
 just does the default, i'm just being explicit since there's a pointer (no deep copy!)
TimerEntryoperator= (const TimerEntry &t)
 just does the default, i'm just being explicit since there's a pointer (no deep copy!)
void Set (unsigned int d, bool r)
 will reset timer

Public Attributes

EventListenerel
 the listener to fire at
unsigned int sid
 the source id to fire with
unsigned int delay
 the delay until firing
unsigned int next
 the time at which this timer will go off next
bool repeat
 if true, will reset after firing, else will be deleted


Constructor & Destructor Documentation

EventRouter::TimerEntry::TimerEntry unsigned int  nxt  )  [inline, explicit]
 

constructors an entry using the given value for next - useful for with TimerEntryPtrCmp

Definition at line 179 of file EventRouter.h.

EventRouter::TimerEntry::TimerEntry EventListener e,
unsigned int  s,
unsigned int  d,
bool  r
[inline]
 

constructs with the given values, sets next field automatically; see next

Definition at line 181 of file EventRouter.h.

EventRouter::TimerEntry::TimerEntry const TimerEntry t  )  [inline]
 

just does the default, i'm just being explicit since there's a pointer (no deep copy!)

Definition at line 183 of file EventRouter.h.


Member Function Documentation

TimerEntry& EventRouter::TimerEntry::operator= const TimerEntry t  )  [inline]
 

just does the default, i'm just being explicit since there's a pointer (no deep copy!)

Definition at line 185 of file EventRouter.h.

void EventRouter::TimerEntry::Set unsigned int  d,
bool  r
[inline]
 

will reset timer

Parameters:
d the time from now when the timer should go off (in milliseconds)
r true if the timer should automatically repeat

Definition at line 189 of file EventRouter.h.


Member Data Documentation

unsigned int EventRouter::TimerEntry::delay
 

the delay until firing

Definition at line 192 of file EventRouter.h.

Referenced by operator=(), and Set().

EventListener* EventRouter::TimerEntry::el
 

the listener to fire at

Definition at line 190 of file EventRouter.h.

Referenced by operator=().

unsigned int EventRouter::TimerEntry::next
 

the time at which this timer will go off next

Definition at line 193 of file EventRouter.h.

Referenced by EventRouter::TimerEntryPtrCmp::operator()(), operator=(), and Set().

bool EventRouter::TimerEntry::repeat
 

if true, will reset after firing, else will be deleted

Definition at line 194 of file EventRouter.h.

Referenced by operator=(), and Set().

unsigned int EventRouter::TimerEntry::sid
 

the source id to fire with

Definition at line 191 of file EventRouter.h.

Referenced by operator=().


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

Tekkotsu v2.4.1
Generated Tue Aug 16 16:35:01 2005 by Doxygen 1.4.4