DtPeriodicTimer Class Reference

File: periTimer.h. More...

Inheritance diagram for DtPeriodicTimer:

List of all members.

Public Member Functions
	DtPeriodicTimer (const DtClock *clock, const unsigned int type, const DtTime period, const DtTimerCallbackFcn callback, void *usr)
	The usr pointer points to some user-specified data that will be passed into the given callback when the timer fires.
virtual	~DtPeriodicTimer ()
virtual void	fire ()
	Sets off (fires) the timer.
Protected Member Functions
DtPeriodicTimer &	operator= (const DtPeriodicTimer &orig)
	not defined
Private Attributes
const DtTime	myPeriod
const DtClock *	myClock

---

Detailed Description

File: periTimer.h.

Class: DtPeriodicTimer

Description: A periodic timer resets itself after firing to fire 'period' seconds after the time at which it was scheduled to fire.

---

Constructor & Destructor Documentation

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

The usr pointer points to some user-specified data that will be passed into 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 DtPeriodicTimer::~DtPeriodicTimer

(

)

[virtual]

---

Member Function Documentation

DtPeriodicTimer& DtPeriodicTimer::operator=

(

const DtPeriodicTimer &

orig

)

[protected]

not defined

virtual void DtPeriodicTimer::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 DtPeriodicTimer::myPeriod [private]

const DtClock* DtPeriodicTimer::myClock [private]

---

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

• include/vrfcore/periTimer.h