VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
DtRecurringTimer Class Reference

File: recTimer.h. More...

Inheritance diagram for DtRecurringTimer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRecurringTimer (const DtClock *clock, const unsigned int type, const DtTime recurTime, const DtTimerCallbackFcn callback, void *usr)
 The usr pointer points to some user-specified data that will be passed in to the given callback when the timer fires.
virtual ~DtRecurringTimer ()
virtual void fire ()
 Sets off (fires) the timer.

Protected Member Functions

DtRecurringTimeroperator= (const DtRecurringTimer &orig)
 not defined

Protected Attributes

const DtTime myRecurTime
const DtClock * myClock

Detailed Description

File: recTimer.h.

Class: DtRecurringTimer

Description: A recurring timer resets itself after firing to fire 'recurTime' seconds after the time at which it fired.


Constructor & Destructor Documentation

DtRecurringTimer::DtRecurringTimer ( const DtClock *  clock,
const unsigned int  type,
const DtTime  recurTime,
const DtTimerCallbackFcn  callback,
void *  usr 
)

The usr pointer points to some user-specified data that will be passed in to the given callback when the timer fires.

The usr pointer is owned by the caller (who is therefore responsible for destroying it) and it should not be modified by this class in any way.

virtual DtRecurringTimer::~DtRecurringTimer ( ) [virtual]

Member Function Documentation

DtRecurringTimer& DtRecurringTimer::operator= ( const DtRecurringTimer orig) [protected]

not defined

virtual void DtRecurringTimer::fire ( ) [virtual]

Sets off (fires) the timer.

Sets the fired state to true. If a callback exists, invokes the callback. If myScheduler has been set, calls scheduler's reSort() member passing in this object as the argument.

Reimplemented from DtTimer.


Member Data Documentation

const DtTime DtRecurringTimer::myRecurTime [protected]
const DtClock* DtRecurringTimer::myClock [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)