classhueplusplus_1_1time_1_1_timer.html
16.8 KB
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::time::Timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">hueplusplus
 <span id="projectnumber">1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="namespacehueplusplus_1_1time.html">time</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html">Timer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="classhueplusplus_1_1time_1_1_timer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::time::Timer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classhueplusplus_1_1time_1_1_timer.html" title="Timer that is started and triggers after specified delay. ">Timer</a> that is started and triggers after specified delay.
<a href="classhueplusplus_1_1time_1_1_timer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_time_pattern_8h_source.html">hueplusplus/TimePattern.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6951cf6d72bf1c11ed2c940b23bdf55f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a6951cf6d72bf1c11ed2c940b23bdf55f">Timer</a> (clock::duration duration, clock::duration variation=std::chrono::seconds(0))</td></tr>
<tr class="memdesc:a6951cf6d72bf1c11ed2c940b23bdf55f"><td class="mdescLeft"> </td><td class="mdescRight">Create one-off timer. <a href="#a6951cf6d72bf1c11ed2c940b23bdf55f">More...</a><br /></td></tr>
<tr class="separator:a6951cf6d72bf1c11ed2c940b23bdf55f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ff3fc9c3d9f32a100b6e398ac5ca7c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a2ff3fc9c3d9f32a100b6e398ac5ca7c6">Timer</a> (clock::duration duration, int numExecutions, clock::duration variation=std::chrono::seconds(0))</td></tr>
<tr class="memdesc:a2ff3fc9c3d9f32a100b6e398ac5ca7c6"><td class="mdescLeft"> </td><td class="mdescRight">Create a repeated timer. <a href="#a2ff3fc9c3d9f32a100b6e398ac5ca7c6">More...</a><br /></td></tr>
<tr class="separator:a2ff3fc9c3d9f32a100b6e398ac5ca7c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9566f3e33d3523506fef646f0cbf2294"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a9566f3e33d3523506fef646f0cbf2294">isRecurring</a> () const</td></tr>
<tr class="memdesc:a9566f3e33d3523506fef646f0cbf2294"><td class="mdescLeft"> </td><td class="mdescRight">Returns true when the timer is executed more than once. <a href="#a9566f3e33d3523506fef646f0cbf2294">More...</a><br /></td></tr>
<tr class="separator:a9566f3e33d3523506fef646f0cbf2294"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e02fb2cc4f2624693de2bba35c0bc05"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a4e02fb2cc4f2624693de2bba35c0bc05">getNumberOfExecutions</a> () const</td></tr>
<tr class="memdesc:a4e02fb2cc4f2624693de2bba35c0bc05"><td class="mdescLeft"> </td><td class="mdescRight">Get number of executions. <a href="#a4e02fb2cc4f2624693de2bba35c0bc05">More...</a><br /></td></tr>
<tr class="separator:a4e02fb2cc4f2624693de2bba35c0bc05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17ba161fff51473bd262fbd3b2692453"><td class="memItemLeft" align="right" valign="top">clock::duration </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a17ba161fff51473bd262fbd3b2692453">getExpiryTime</a> () const</td></tr>
<tr class="memdesc:a17ba161fff51473bd262fbd3b2692453"><td class="mdescLeft"> </td><td class="mdescRight">Get expiry time. <a href="#a17ba161fff51473bd262fbd3b2692453">More...</a><br /></td></tr>
<tr class="separator:a17ba161fff51473bd262fbd3b2692453"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae97cb1b5165452af834acdb6782489e9"><td class="memItemLeft" align="right" valign="top">clock::duration </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#ae97cb1b5165452af834acdb6782489e9">getRandomVariation</a> () const</td></tr>
<tr class="memdesc:ae97cb1b5165452af834acdb6782489e9"><td class="mdescLeft"> </td><td class="mdescRight">Get random variation of expiry time. <a href="#ae97cb1b5165452af834acdb6782489e9">More...</a><br /></td></tr>
<tr class="separator:ae97cb1b5165452af834acdb6782489e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef01fc3280be4f4c28ad6b8324929950"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#aef01fc3280be4f4c28ad6b8324929950">toString</a> () const</td></tr>
<tr class="memdesc:aef01fc3280be4f4c28ad6b8324929950"><td class="mdescLeft"> </td><td class="mdescRight">Get formatted string as expected by Hue API. <a href="#aef01fc3280be4f4c28ad6b8324929950">More...</a><br /></td></tr>
<tr class="separator:aef01fc3280be4f4c28ad6b8324929950"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a85065c8ab737430c3345d2d9ce4eff2d"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a85065c8ab737430c3345d2d9ce4eff2d">infiniteExecutions</a> = 0</td></tr>
<tr class="separator:a85065c8ab737430c3345d2d9ce4eff2d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classhueplusplus_1_1time_1_1_timer.html" title="Timer that is started and triggers after specified delay. ">Timer</a> that is started and triggers after specified delay. </p>
<p>The timer can have a random variation in the expiry time. It can be one-off, repeated a set number of times or repeated indefinitely. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a6951cf6d72bf1c11ed2c940b23bdf55f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6951cf6d72bf1c11ed2c940b23bdf55f">◆ </a></span>Timer() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::time::Timer::Timer </td>
<td>(</td>
<td class="paramtype">clock::duration </td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">clock::duration </td>
<td class="paramname"><em>variation</em> = <code>std::chrono::seconds(0)</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create one-off timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duration</td><td>Expiry time of the timer, max 24 hours. </td></tr>
<tr><td class="paramname">variation</td><td>Random variation of expiry time, optional. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2ff3fc9c3d9f32a100b6e398ac5ca7c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ff3fc9c3d9f32a100b6e398ac5ca7c6">◆ </a></span>Timer() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::time::Timer::Timer </td>
<td>(</td>
<td class="paramtype">clock::duration </td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numExecutions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">clock::duration </td>
<td class="paramname"><em>variation</em> = <code>std::chrono::seconds(0)</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a repeated timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duration</td><td>Expiry time of the timer, max 24 hours. </td></tr>
<tr><td class="paramname">numExecutions</td><td>Number of executions, 1 or higher, or <a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a85065c8ab737430c3345d2d9ce4eff2d">infiniteExecutions</a> to always repeat. </td></tr>
<tr><td class="paramname">variation</td><td>Random variation of expiry time, optional. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a17ba161fff51473bd262fbd3b2692453"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17ba161fff51473bd262fbd3b2692453">◆ </a></span>getExpiryTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">system_clock::duration hueplusplus::time::Timer::getExpiryTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get expiry time. </p>
</div>
</div>
<a id="a4e02fb2cc4f2624693de2bba35c0bc05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e02fb2cc4f2624693de2bba35c0bc05">◆ </a></span>getNumberOfExecutions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hueplusplus::time::Timer::getNumberOfExecutions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of executions. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of executions, or <a class="el" href="classhueplusplus_1_1time_1_1_timer.html#a85065c8ab737430c3345d2d9ce4eff2d">infiniteExecutions</a> </dd></dl>
</div>
</div>
<a id="ae97cb1b5165452af834acdb6782489e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae97cb1b5165452af834acdb6782489e9">◆ </a></span>getRandomVariation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">system_clock::duration hueplusplus::time::Timer::getRandomVariation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get random variation of expiry time. </p>
<p>The expiry time can vary up to this value in both directions. </p>
</div>
</div>
<a id="a9566f3e33d3523506fef646f0cbf2294"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9566f3e33d3523506fef646f0cbf2294">◆ </a></span>isRecurring()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::time::Timer::isRecurring </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true when the timer is executed more than once. </p>
</div>
</div>
<a id="aef01fc3280be4f4c28ad6b8324929950"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef01fc3280be4f4c28ad6b8324929950">◆ </a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::time::Timer::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get formatted string as expected by Hue API. </p>
<dl class="section return"><dt>Returns</dt><dd>one-off timer: <b>PT</b><code>hh:mm:ss</code> </dd>
<dd>
one-off timer with variation: <b>PT</b><code>hh:mm:ss</code><b>A</b><code>hh:mm:ss</code>, with expiry time first and variation second. </dd>
<dd>
recurring timer: <b>R/PT</b><code>hh:mm:ss</code> </dd>
<dd>
recurring timer with n repetitions: <b>R</b><code>nn</code><b>/PT</b><code>hh:mm:ss</code> </dd>
<dd>
recurring timer with random variation: <b>R</b><code>nn</code><b>/PT</b><code>hh:mm:ss</code><b>A</b><code>hh:mm:ss</code> </dd>
<dd>
infinite recurring timer with random variation: <b>R</b><b>/PT</b><code>hh:mm:ss</code><b>A</b><code>hh:mm:ss</code> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a85065c8ab737430c3345d2d9ce4eff2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85065c8ab737430c3345d2d9ce4eff2d">◆ </a></span>infiniteExecutions</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr int hueplusplus::time::Timer::infiniteExecutions = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_time_pattern_8h_source.html">TimePattern.h</a></li>
<li>src/<a class="el" href="_time_pattern_8cpp.html">TimePattern.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>