GHOST_TimerTask Class Reference

#include <GHOST_TimerTask.h>

Inheritance diagram for GHOST_TimerTask:

List of all members.

Public Member Functions
	GHOST_TimerTask (GHOST_TUns64 start, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=0)
virtual GHOST_TUns64	getStart () const
virtual void	setStart (GHOST_TUns64 start)
virtual GHOST_TUns64	getInterval () const
virtual void	setInterval (GHOST_TUns64 interval)
virtual GHOST_TUns64	getNext () const
virtual void	setNext (GHOST_TUns64 next)
virtual GHOST_TimerProcPtr	getTimerProc () const
virtual void	setTimerProc (const GHOST_TimerProcPtr timerProc)
virtual GHOST_TUserDataPtr	getUserData () const
virtual void	setUserData (const GHOST_TUserDataPtr userData)
virtual GHOST_TUns32	getAuxData () const
virtual void	setAuxData (GHOST_TUns32 auxData)
Protected Attributes
GHOST_TUns64	m_start
GHOST_TUns64	m_interval
GHOST_TUns64	m_next
GHOST_TimerProcPtr	m_timerProc
GHOST_TUserDataPtr	m_userData
GHOST_TUns32	m_auxData

---

Detailed Description

Implementation of a timer task.

Author:

Maarten Gribnau

Date:

May 28, 2001

Definition at line 45 of file GHOST_TimerTask.h.

---

Constructor & Destructor Documentation

GHOST_TimerTask::GHOST_TimerTask	(	GHOST_TUns64	start,
		GHOST_TUns64	interval,
		GHOST_TimerProcPtr	timerProc,
		GHOST_TUserDataPtr	userData = 0
	)		[inline]

Constructor.

Parameters:

start	The timer start time.
interval	The interval between calls to the timerProc
timerProc	The callbak invoked when the interval expires.
data	The timer user data.

Definition at line 55 of file GHOST_TimerTask.h.

---

Member Function Documentation

virtual GHOST_TUns32 GHOST_TimerTask::getAuxData

(

)

const [inline, virtual]

Returns the auxiliary storage room.

Returns:

The auxiliary storage room.

Definition at line 154 of file GHOST_TimerTask.h.

References m_auxData.

virtual GHOST_TUns64 GHOST_TimerTask::getInterval

(

)

const [inline, virtual]

Returns the timer interval.

Returns:

The timer interval.

Definition at line 82 of file GHOST_TimerTask.h.

References m_interval.

Referenced by GHOST_TimerManager::fireTimer().

virtual GHOST_TUns64 GHOST_TimerTask::getNext

(

)

const [inline, virtual]

Returns the time the timerProc will be called.

Returns:

The time the timerProc will be called.

Definition at line 100 of file GHOST_TimerTask.h.

References m_next.

Referenced by GHOST_TimerManager::fireTimer().

virtual GHOST_TUns64 GHOST_TimerTask::getStart

(

void

)

const [inline, virtual]

Returns the timer start time.

Returns:

The timer start time.

Definition at line 64 of file GHOST_TimerTask.h.

References m_start.

Referenced by GHOST_TimerManager::fireTimer().

virtual GHOST_TimerProcPtr GHOST_TimerTask::getTimerProc

(

)

const [inline, virtual]

Returns the timer callback.

Returns:

the timer callback.

Implements GHOST_ITimerTask.

Definition at line 118 of file GHOST_TimerTask.h.

References m_timerProc.

Referenced by GHOST_TimerManager::fireTimer().

virtual GHOST_TUserDataPtr GHOST_TimerTask::getUserData

(

)

const [inline, virtual]

Returns the timer user data.

Returns:

The timer user data.

Implements GHOST_ITimerTask.

Definition at line 136 of file GHOST_TimerTask.h.

References m_userData.

virtual void GHOST_TimerTask::setAuxData

(

GHOST_TUns32

auxData

)

[inline, virtual]

Changes the auxiliary storage room.

Parameters:

auxData

The auxiliary storage room.

Definition at line 163 of file GHOST_TimerTask.h.

References m_auxData.

virtual void GHOST_TimerTask::setInterval

(

GHOST_TUns64

interval

)

[inline, virtual]

Changes the timer interval.

Parameters:

interval

The timer interval.

Definition at line 91 of file GHOST_TimerTask.h.

References m_interval.

virtual void GHOST_TimerTask::setNext

(

GHOST_TUns64

next

)

[inline, virtual]

Changes the time the timerProc will be called.

Parameters:

next	The time the timerProc will be called.

Definition at line 109 of file GHOST_TimerTask.h.

References m_next, and next.

Referenced by GHOST_TimerManager::fireTimer().

virtual void GHOST_TimerTask::setStart

(

GHOST_TUns64

start

)

[inline, virtual]

Changes the timer start time.

Parameters:

start

The timer start time.

Definition at line 73 of file GHOST_TimerTask.h.

References m_start.

virtual void GHOST_TimerTask::setTimerProc

(

const GHOST_TimerProcPtr

timerProc

)

[inline, virtual]

Changes the timer callback.

Parameters:

The	timer callback.

Implements GHOST_ITimerTask.

Definition at line 127 of file GHOST_TimerTask.h.

References m_timerProc.

virtual void GHOST_TimerTask::setUserData

(

const GHOST_TUserDataPtr

userData

)

[inline, virtual]

Changes the time user data.

Parameters:

data	The timer user data.

Implements GHOST_ITimerTask.

Definition at line 145 of file GHOST_TimerTask.h.

References m_userData.

---

Member Data Documentation

GHOST_TUns32 GHOST_TimerTask::m_auxData [protected]

Auxiliary storage room.

Definition at line 185 of file GHOST_TimerTask.h.

Referenced by getAuxData(), and setAuxData().

GHOST_TUns64 GHOST_TimerTask::m_interval [protected]

The interval between calls.

Definition at line 173 of file GHOST_TimerTask.h.

Referenced by getInterval(), and setInterval().

GHOST_TUns64 GHOST_TimerTask::m_next [protected]

The time the timerProc will be called.

Definition at line 176 of file GHOST_TimerTask.h.

Referenced by getNext(), and setNext().

GHOST_TUns64 GHOST_TimerTask::m_start [protected]

The time the timer task was started.

Definition at line 170 of file GHOST_TimerTask.h.

Referenced by getStart(), and setStart().

GHOST_TimerProcPtr GHOST_TimerTask::m_timerProc [protected]

The callback invoked when the timer expires.

Definition at line 179 of file GHOST_TimerTask.h.

Referenced by getTimerProc(), and setTimerProc().

GHOST_TUserDataPtr GHOST_TimerTask::m_userData [protected]

The timer task user data.

Definition at line 182 of file GHOST_TimerTask.h.

Referenced by getUserData(), and setUserData().

---

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

• GHOST_TimerTask.h