Blender V2.61 - r43446
Public Member Functions | Protected Attributes

GHOST_TimerTask Class Reference

#include <GHOST_TimerTask.h>

Inheritance diagram for GHOST_TimerTask:
Inheritance graph
[legend]

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 44 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:
startThe timer start time.
intervalThe interval between calls to the timerProc
timerProcThe callbak invoked when the interval expires.
dataThe timer user data.

Definition at line 54 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 161 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 89 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 107 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 71 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 125 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 143 of file GHOST_TimerTask.h.

References m_userData.

virtual void GHOST_TimerTask::setAuxData ( GHOST_TUns32  auxData) [inline, virtual]

Changes the auxiliary storage room.

Parameters:
auxDataThe auxiliary storage room.

Definition at line 170 of file GHOST_TimerTask.h.

References m_auxData.

virtual void GHOST_TimerTask::setInterval ( GHOST_TUns64  interval) [inline, virtual]

Changes the timer interval.

Parameters:
intervalThe timer interval.

Definition at line 98 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:
nextThe time the timerProc will be called.

Definition at line 116 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:
startThe timer start time.

Definition at line 80 of file GHOST_TimerTask.h.

References m_start.

virtual void GHOST_TimerTask::setTimerProc ( const GHOST_TimerProcPtr  timerProc) [inline, virtual]

Changes the timer callback.

Parameters:
Thetimer callback.

Implements GHOST_ITimerTask.

Definition at line 134 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:
dataThe timer user data.

Implements GHOST_ITimerTask.

Definition at line 152 of file GHOST_TimerTask.h.

References m_userData.


Member Data Documentation

Auxiliary storage room.

Definition at line 192 of file GHOST_TimerTask.h.

Referenced by getAuxData(), and setAuxData().

The interval between calls.

Definition at line 180 of file GHOST_TimerTask.h.

Referenced by getInterval(), and setInterval().

The time the timerProc will be called.

Definition at line 183 of file GHOST_TimerTask.h.

Referenced by getNext(), and setNext().

The time the timer task was started.

Definition at line 177 of file GHOST_TimerTask.h.

Referenced by getStart(), and setStart().

The callback invoked when the timer expires.

Definition at line 186 of file GHOST_TimerTask.h.

Referenced by getTimerProc(), and setTimerProc().

The timer task user data.

Definition at line 189 of file GHOST_TimerTask.h.

Referenced by getUserData(), and setUserData().


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