GHOST_TimerTask Class Reference

#include <GHOST_TimerTask.h>

Inherits GHOST_ITimerTask.

Public Member Functions
	GHOST_TimerTask (GHOST_TUns64 start, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=NULL)
GHOST_TUns64	getStart () const
void	setStart (GHOST_TUns64 start)
GHOST_TUns64	getInterval () const
void	setInterval (GHOST_TUns64 interval)
GHOST_TUns64	getNext () const
void	setNext (GHOST_TUns64 next)
GHOST_TimerProcPtr	getTimerProc () const
void	setTimerProc (const GHOST_TimerProcPtr timerProc)
GHOST_TUserDataPtr	getUserData () const
void	setUserData (const GHOST_TUserDataPtr userData)
GHOST_TUns32	getAuxData () const
void	setAuxData (GHOST_TUns32 auxData)
Public Member Functions inherited from GHOST_ITimerTask
virtual	~GHOST_ITimerTask ()

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.

Definition at line 32 of file GHOST_TimerTask.h.

Constructor & Destructor Documentation

GHOST_TimerTask()

GHOST_TimerTask::GHOST_TimerTask ( GHOST_TUns64  start, GHOST_TUns64  interval, GHOST_TimerProcPtr  timerProc, GHOST_TUserDataPtr  userData = NULL  )

inline

Constructor.

Parameters

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

Definition at line 41 of file GHOST_TimerTask.h.

Member Function Documentation

getAuxData()

GHOST_TUns32 GHOST_TimerTask::getAuxData ( ) const

inline

Returns the auxiliary storage room.

Returns

The auxiliary storage room.

Definition at line 148 of file GHOST_TimerTask.h.

References m_auxData.

getInterval()

GHOST_TUns64 GHOST_TimerTask::getInterval ( ) const

inline

Returns the timer interval.

Returns

The timer interval.

Definition at line 76 of file GHOST_TimerTask.h.

References m_interval.

getNext()

GHOST_TUns64 GHOST_TimerTask::getNext ( ) const

inline

Returns the time the timerProc will be called.

Returns

The time the timerProc will be called.

Definition at line 94 of file GHOST_TimerTask.h.

References m_next.

getStart()

GHOST_TUns64 GHOST_TimerTask::getStart ( ) const

inline

Returns the timer start time.

Returns

The timer start time.

Definition at line 58 of file GHOST_TimerTask.h.

References m_start.

getTimerProc()

GHOST_TimerProcPtr GHOST_TimerTask::getTimerProc ( ) const

inlinevirtual

Returns the timer callback.

Returns

the timer callback.

Implements GHOST_ITimerTask.

Definition at line 112 of file GHOST_TimerTask.h.

References m_timerProc.

getUserData()

GHOST_TUserDataPtr GHOST_TimerTask::getUserData ( ) const

inlinevirtual

Returns the timer user data.

Returns

The timer user data.

Implements GHOST_ITimerTask.

Definition at line 130 of file GHOST_TimerTask.h.

References m_userData.

setAuxData()

void GHOST_TimerTask::setAuxData ( GHOST_TUns32  auxData )

inline

Changes the auxiliary storage room.

Parameters

auxData

The auxiliary storage room.

Definition at line 157 of file GHOST_TimerTask.h.

References m_auxData.

setInterval()

void GHOST_TimerTask::setInterval ( GHOST_TUns64  interval )

inline

Changes the timer interval.

Parameters

interval

The timer interval.

Definition at line 85 of file GHOST_TimerTask.h.

References m_interval.

setNext()

void GHOST_TimerTask::setNext ( GHOST_TUns64  next )

inline

Changes the time the timerProc will be called.

Parameters

next	The time the timerProc will be called.

Definition at line 103 of file GHOST_TimerTask.h.

References m_next, and next.

setStart()

void GHOST_TimerTask::setStart ( GHOST_TUns64  start )

inline

Changes the timer start time.

Parameters

start

The timer start time.

Definition at line 67 of file GHOST_TimerTask.h.

References m_start.

setTimerProc()

void GHOST_TimerTask::setTimerProc ( const GHOST_TimerProcPtr  timerProc )

inlinevirtual

Changes the timer callback.

Parameters

timerProc

The timer callback.

Implements GHOST_ITimerTask.

Definition at line 121 of file GHOST_TimerTask.h.

References m_timerProc.

setUserData()

void GHOST_TimerTask::setUserData ( const GHOST_TUserDataPtr  userData )

inlinevirtual

Changes the time user data.

Parameters

userData

The timer user data.

Implements GHOST_ITimerTask.

Definition at line 139 of file GHOST_TimerTask.h.

References m_userData.

Member Data Documentation

m_auxData

GHOST_TUns32 GHOST_TimerTask::m_auxData

protected

Auxiliary storage room.

Definition at line 179 of file GHOST_TimerTask.h.

Referenced by getAuxData(), and setAuxData().

m_interval

GHOST_TUns64 GHOST_TimerTask::m_interval

protected

The interval between calls.

Definition at line 167 of file GHOST_TimerTask.h.

Referenced by getInterval(), and setInterval().

m_next

GHOST_TUns64 GHOST_TimerTask::m_next

protected

The time the timerProc will be called.

Definition at line 170 of file GHOST_TimerTask.h.

Referenced by getNext(), and setNext().

m_start

GHOST_TUns64 GHOST_TimerTask::m_start

protected

The time the timer task was started.

Definition at line 164 of file GHOST_TimerTask.h.

Referenced by getStart(), and setStart().

m_timerProc

GHOST_TimerProcPtr GHOST_TimerTask::m_timerProc

protected

The callback invoked when the timer expires.

Definition at line 173 of file GHOST_TimerTask.h.

Referenced by getTimerProc(), and setTimerProc().

m_userData

GHOST_TUserDataPtr GHOST_TimerTask::m_userData

protected

The timer task user data.

Definition at line 176 of file GHOST_TimerTask.h.

Referenced by getUserData(), and setUserData().

---

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

• GHOST_TimerTask.h