classhueplusplus_1_1time_1_1_recurring_time.html
12.2 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
<!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::RecurringTime 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_recurring_time.html">RecurringTime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhueplusplus_1_1time_1_1_recurring_time-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::time::RecurringTime Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Time repeated weekly to daily, with possible random variation.
<a href="classhueplusplus_1_1time_1_1_recurring_time.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:a5e06f7388dbbe93f618c59f56857ef10"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html#a5e06f7388dbbe93f618c59f56857ef10">RecurringTime</a> (clock::duration daytime, <a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html">Weekdays</a> days, clock::duration variation=std::chrono::seconds(0))</td></tr>
<tr class="memdesc:a5e06f7388dbbe93f618c59f56857ef10"><td class="mdescLeft"> </td><td class="mdescRight">Create recurring time. <a href="#a5e06f7388dbbe93f618c59f56857ef10">More...</a><br /></td></tr>
<tr class="separator:a5e06f7388dbbe93f618c59f56857ef10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab709e2ed62f8f4926e3e3639a904b3d8"><td class="memItemLeft" align="right" valign="top">clock::duration </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html#ab709e2ed62f8f4926e3e3639a904b3d8">getDaytime</a> () const</td></tr>
<tr class="memdesc:ab709e2ed62f8f4926e3e3639a904b3d8"><td class="mdescLeft"> </td><td class="mdescRight">Get time of day. <a href="#ab709e2ed62f8f4926e3e3639a904b3d8">More...</a><br /></td></tr>
<tr class="separator:ab709e2ed62f8f4926e3e3639a904b3d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9148416a97cd408d535e9e76864d8aa"><td class="memItemLeft" align="right" valign="top">clock::duration </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html#aa9148416a97cd408d535e9e76864d8aa">getRandomVariation</a> () const</td></tr>
<tr class="memdesc:aa9148416a97cd408d535e9e76864d8aa"><td class="mdescLeft"> </td><td class="mdescRight">Get random variation. <a href="#aa9148416a97cd408d535e9e76864d8aa">More...</a><br /></td></tr>
<tr class="separator:aa9148416a97cd408d535e9e76864d8aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf4155d15e150b4ab842d269e28b3133"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html">Weekdays</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html#acf4155d15e150b4ab842d269e28b3133">getWeekdays</a> () const</td></tr>
<tr class="memdesc:acf4155d15e150b4ab842d269e28b3133"><td class="mdescLeft"> </td><td class="mdescRight">Get days on which the repetition will happen. <a href="#acf4155d15e150b4ab842d269e28b3133">More...</a><br /></td></tr>
<tr class="separator:acf4155d15e150b4ab842d269e28b3133"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab67b7999b68c968fcde7f1ef78019eac"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html#ab67b7999b68c968fcde7f1ef78019eac">toString</a> () const</td></tr>
<tr class="memdesc:ab67b7999b68c968fcde7f1ef78019eac"><td class="mdescLeft"> </td><td class="mdescRight">Get formatted string as expected by Hue API. <a href="#ab67b7999b68c968fcde7f1ef78019eac">More...</a><br /></td></tr>
<tr class="separator:ab67b7999b68c968fcde7f1ef78019eac"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Time repeated weekly to daily, with possible random variation. </p>
<p>Can be used to represent a time on one or multiple days per week. It can also have a random variation of up to 12 hours. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5e06f7388dbbe93f618c59f56857ef10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e06f7388dbbe93f618c59f56857ef10">◆ </a></span>RecurringTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hueplusplus::time::RecurringTime::RecurringTime </td>
<td>(</td>
<td class="paramtype">clock::duration </td>
<td class="paramname"><em>daytime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html">Weekdays</a> </td>
<td class="paramname"><em>days</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create recurring time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">daytime</td><td>Time of day, duration from the start of the day. </td></tr>
<tr><td class="paramname">days</td><td>Days to repeat on, should not be <a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html#ae698598e1d051a6f23cc9e497eb7947c" title="Creates an empty Weekdays. ">Weekdays::none()</a> </td></tr>
<tr><td class="paramname">variation</td><td>Random variation, optional. Must be less than 12 hours. When not zero, the time is randomly chosen between <code>daytime - variation</code> and <code>daytime + variation</code> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab709e2ed62f8f4926e3e3639a904b3d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab709e2ed62f8f4926e3e3639a904b3d8">◆ </a></span>getDaytime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">system_clock::duration hueplusplus::time::RecurringTime::getDaytime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get time of day. </p>
</div>
</div>
<a id="aa9148416a97cd408d535e9e76864d8aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9148416a97cd408d535e9e76864d8aa">◆ </a></span>getRandomVariation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">system_clock::duration hueplusplus::time::RecurringTime::getRandomVariation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get random variation. </p>
<p>The time can vary up to this amount in both directions. </p>
</div>
</div>
<a id="acf4155d15e150b4ab842d269e28b3133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf4155d15e150b4ab842d269e28b3133">◆ </a></span>getWeekdays()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html">Weekdays</a> hueplusplus::time::RecurringTime::getWeekdays </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get days on which the repetition will happen. </p>
</div>
</div>
<a id="ab67b7999b68c968fcde7f1ef78019eac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab67b7999b68c968fcde7f1ef78019eac">◆ </a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::time::RecurringTime::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>with no variation: <b>W</b><code>bbb</code><b>/T</b><code>hh:mm:ss</code> </dd>
<dd>
with variation: <b>W</b><code>bbb</code><b>/T</b><code>hh:mm:ss</code><b>A</b><code>hh:mm:ss</code>, where daytime is first and variation is second. </dd></dl>
</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>