blob: 8ca8e36837ed2c3e026b1a6f35957a3716cd29f8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2001-2002 NaN Holding BV. All rights reserved. */
/** \file
* \ingroup GHOST
* Declaration of GHOST_TimerTask class.
*/
#pragma once
#include "GHOST_ITimerTask.h"
/**
* Implementation of a timer task.
*/
class GHOST_TimerTask : public GHOST_ITimerTask {
public:
/**
* Constructor.
* \param start: The timer start time.
* \param interval: The interval between calls to the #timerProc.
* \param timerProc: The callback invoked when the interval expires.
* \param userData: The timer user data.
*/
GHOST_TimerTask(uint64_t start,
uint64_t interval,
GHOST_TimerProcPtr timerProc,
GHOST_TUserDataPtr userData = nullptr)
: m_start(start),
m_interval(interval),
m_next(start),
m_timerProc(timerProc),
m_userData(userData),
m_auxData(0)
{
}
/**
* Returns the timer start time.
* \return The timer start time.
*/
inline uint64_t getStart() const
{
return m_start;
}
/**
* Changes the timer start time.
* \param start: The timer start time.
*/
void setStart(uint64_t start)
{
m_start = start;
}
/**
* Returns the timer interval.
* \return The timer interval.
*/
inline uint64_t getInterval() const
{
return m_interval;
}
/**
* Changes the timer interval.
* \param interval: The timer interval.
*/
void setInterval(uint64_t interval)
{
m_interval = interval;
}
/**
* Returns the time the timerProc will be called.
* \return The time the timerProc will be called.
*/
inline uint64_t getNext() const
{
return m_next;
}
/**
* Changes the time the timerProc will be called.
* \param next: The time the timerProc will be called.
*/
void setNext(uint64_t next)
{
m_next = next;
}
/**
* Returns the timer callback.
* \return the timer callback.
*/
inline GHOST_TimerProcPtr getTimerProc() const
{
return m_timerProc;
}
/**
* Changes the timer callback.
* \param timerProc: The timer callback.
*/
inline void setTimerProc(const GHOST_TimerProcPtr timerProc)
{
m_timerProc = timerProc;
}
/**
* Returns the timer user data.
* \return The timer user data.
*/
inline GHOST_TUserDataPtr getUserData() const
{
return m_userData;
}
/**
* Changes the time user data.
* \param userData: The timer user data.
*/
void setUserData(const GHOST_TUserDataPtr userData)
{
m_userData = userData;
}
/**
* Returns the auxiliary storage room.
* \return The auxiliary storage room.
*/
inline uint32_t getAuxData() const
{
return m_auxData;
}
/**
* Changes the auxiliary storage room.
* \param auxData: The auxiliary storage room.
*/
void setAuxData(uint32_t auxData)
{
m_auxData = auxData;
}
protected:
/** The time the timer task was started. */
uint64_t m_start;
/** The interval between calls. */
uint64_t m_interval;
/** The time the timerProc will be called. */
uint64_t m_next;
/** The callback invoked when the timer expires. */
GHOST_TimerProcPtr m_timerProc;
/** The timer task user data. */
GHOST_TUserDataPtr m_userData;
/** Auxiliary storage room. */
uint32_t m_auxData;
};
|
