GHOST_TimerTask Class Reference

#include <GHOST_TimerTask.hh>

Inherits GHOST_ITimerTask.

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

Protected Attributes
uint64_t	m_start
uint64_t	m_interval
uint64_t	m_next
GHOST_TimerProcPtr	m_timerProc
GHOST_TUserDataPtr	m_userData
uint32_t	m_auxData = 0

Detailed Description

Implementation of a timer task.

Definition at line 17 of file GHOST_TimerTask.hh.

Constructor & Destructor Documentation

GHOST_TimerTask()

GHOST_TimerTask::GHOST_TimerTask ( uint64_t start, uint64_t interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = nullptr )

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 26 of file GHOST_TimerTask.hh.

References m_interval, m_next, m_start, m_timerProc, and m_userData.

Member Function Documentation

getAuxData()

uint32_t GHOST_TimerTask::getAuxData ( ) const

inline

Returns the auxiliary storage room.

Returns

The auxiliary storage room.

Definition at line 132 of file GHOST_TimerTask.hh.

References m_auxData.

getInterval()

uint64_t GHOST_TimerTask::getInterval ( ) const

inline

Returns the timer interval.

Returns

The timer interval.

Definition at line 60 of file GHOST_TimerTask.hh.

References m_interval.

Referenced by GHOST_TimerManager::fireTimer().

getNext()

uint64_t GHOST_TimerTask::getNext ( ) const

inline

Returns the time the timerProc will be called.

Returns

The time the timerProc will be called.

Definition at line 78 of file GHOST_TimerTask.hh.

References m_next.

Referenced by GHOST_TimerManager::fireTimer().

getStart()

uint64_t GHOST_TimerTask::getStart ( ) const

inline

Returns the timer start time.

Returns

The timer start time.

Definition at line 42 of file GHOST_TimerTask.hh.

References m_start.

Referenced by GHOST_TimerManager::fireTimer().

getTimerProc()

GHOST_TimerProcPtr GHOST_TimerTask::getTimerProc ( ) const

inlineoverridevirtual

Returns the timer callback.

Returns

the timer callback.

Implements GHOST_ITimerTask.

Definition at line 96 of file GHOST_TimerTask.hh.

References m_timerProc.

Referenced by GHOST_TimerManager::fireTimer().

getUserData()

GHOST_TUserDataPtr GHOST_TimerTask::getUserData ( ) const

inlineoverridevirtual

Returns the timer user data.

Returns

The timer user data.

Implements GHOST_ITimerTask.

Definition at line 114 of file GHOST_TimerTask.hh.

References m_userData.

setAuxData()

void GHOST_TimerTask::setAuxData ( uint32_t auxData )

inline

Changes the auxiliary storage room.

Parameters

auxData

The auxiliary storage room.

Definition at line 141 of file GHOST_TimerTask.hh.

References m_auxData.

setInterval()

void GHOST_TimerTask::setInterval ( uint64_t interval )

inline

Changes the timer interval.

Parameters

interval

The timer interval.

Definition at line 69 of file GHOST_TimerTask.hh.

References m_interval.

setNext()

void GHOST_TimerTask::setNext ( uint64_t next )

inline

Changes the time the timerProc will be called.

Parameters

next	The time the timerProc will be called.

Definition at line 87 of file GHOST_TimerTask.hh.

References m_next, and next.

Referenced by GHOST_TimerManager::fireTimer().

setStart()

void GHOST_TimerTask::setStart ( uint64_t start )

inline

Changes the timer start time.

Parameters

start

The timer start time.

Definition at line 51 of file GHOST_TimerTask.hh.

References m_start.

setTimerProc()

void GHOST_TimerTask::setTimerProc ( const GHOST_TimerProcPtr timerProc )

inlineoverridevirtual

Changes the timer callback.

Parameters

timerProc

The timer callback.

Implements GHOST_ITimerTask.

Definition at line 105 of file GHOST_TimerTask.hh.

References m_timerProc.

setUserData()

void GHOST_TimerTask::setUserData ( const GHOST_TUserDataPtr userData )

inlineoverridevirtual

Changes the time user data.

Parameters

userData

The timer user data.

Implements GHOST_ITimerTask.

Definition at line 123 of file GHOST_TimerTask.hh.

References m_userData.

Member Data Documentation

m_auxData

uint32_t GHOST_TimerTask::m_auxData = 0

protected

Auxiliary storage room.

Definition at line 163 of file GHOST_TimerTask.hh.

Referenced by getAuxData(), and setAuxData().

m_interval

uint64_t GHOST_TimerTask::m_interval

protected

The interval between calls.

Definition at line 151 of file GHOST_TimerTask.hh.

Referenced by getInterval(), GHOST_TimerTask(), and setInterval().

m_next

uint64_t GHOST_TimerTask::m_next

protected

The time the timerProc will be called.

Definition at line 154 of file GHOST_TimerTask.hh.

Referenced by getNext(), GHOST_TimerTask(), and setNext().

m_start

uint64_t GHOST_TimerTask::m_start

protected

The time the timer task was started.

Definition at line 148 of file GHOST_TimerTask.hh.

Referenced by getStart(), GHOST_TimerTask(), and setStart().

m_timerProc

GHOST_TimerProcPtr GHOST_TimerTask::m_timerProc

protected

The callback invoked when the timer expires.

Definition at line 157 of file GHOST_TimerTask.hh.

Referenced by getTimerProc(), GHOST_TimerTask(), and setTimerProc().

m_userData

GHOST_TUserDataPtr GHOST_TimerTask::m_userData

protected

The timer task user data.

Definition at line 160 of file GHOST_TimerTask.hh.

Referenced by getUserData(), GHOST_TimerTask(), and setUserData().

---

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

• GHOST_TimerTask.hh