namespacehueplusplus_1_1time.html
17 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
<!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 Namespace 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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::time Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Namespace for time/date related classes and functions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_time.html">AbsoluteTime</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">One-time, absolute time point. <a href="classhueplusplus_1_1time_1_1_absolute_time.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_absolute_varied_time.html">AbsoluteVariedTime</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_recurring_time.html">RecurringTime</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Time repeated weekly to daily, with possible random variation. <a href="classhueplusplus_1_1time_1_1_recurring_time.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_time_interval.html">TimeInterval</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Time interval repeated daily to weekly. <a href="classhueplusplus_1_1time_1_1_time_interval.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_time_pattern.html">TimePattern</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Holds different time representations. <a href="classhueplusplus_1_1time_1_1_time_pattern.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_timer.html">Timer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><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><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1time_1_1_weekdays.html">Weekdays</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Any number of days of the week. <a href="classhueplusplus_1_1time_1_1_weekdays.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afd15eb6e086c8242a2e202536fa4c02b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#afd15eb6e086c8242a2e202536fa4c02b">timepointToTimestamp</a> (std::chrono::system_clock::time_point time)</td></tr>
<tr class="memdesc:afd15eb6e086c8242a2e202536fa4c02b"><td class="mdescLeft"> </td><td class="mdescRight">Converts a time_point to a timestamp string. <a href="#afd15eb6e086c8242a2e202536fa4c02b">More...</a><br /></td></tr>
<tr class="separator:afd15eb6e086c8242a2e202536fa4c02b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84b6a46eb1f4a03ab7740104a8616007"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#a84b6a46eb1f4a03ab7740104a8616007">parseTimestamp</a> (const std::string &timestamp)</td></tr>
<tr class="memdesc:a84b6a46eb1f4a03ab7740104a8616007"><td class="mdescLeft"> </td><td class="mdescRight">Converts a timestamp to a time_point. <a href="#a84b6a46eb1f4a03ab7740104a8616007">More...</a><br /></td></tr>
<tr class="separator:a84b6a46eb1f4a03ab7740104a8616007"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31275be9b8ff39ee8445787b59ad1235"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#a31275be9b8ff39ee8445787b59ad1235">parseUTCTimestamp</a> (const std::string &timestamp)</td></tr>
<tr class="memdesc:a31275be9b8ff39ee8445787b59ad1235"><td class="mdescLeft"> </td><td class="mdescRight">Converts an UTC timestamp to a time_point. <a href="#a31275be9b8ff39ee8445787b59ad1235">More...</a><br /></td></tr>
<tr class="separator:a31275be9b8ff39ee8445787b59ad1235"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeee784c375bcc301727eab3fe8e67d03"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#aeee784c375bcc301727eab3fe8e67d03">durationTo_hh_mm_ss</a> (std::chrono::system_clock::duration duration)</td></tr>
<tr class="memdesc:aeee784c375bcc301727eab3fe8e67d03"><td class="mdescLeft"> </td><td class="mdescRight">Converts duration to a time string. <a href="#aeee784c375bcc301727eab3fe8e67d03">More...</a><br /></td></tr>
<tr class="separator:aeee784c375bcc301727eab3fe8e67d03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee172420a332a222f34f9e9eaf6c5621"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::duration </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus_1_1time.html#aee172420a332a222f34f9e9eaf6c5621">parseDuration</a> (const std::string &hourMinSec)</td></tr>
<tr class="memdesc:aee172420a332a222f34f9e9eaf6c5621"><td class="mdescLeft"> </td><td class="mdescRight">Converts time string to a duration. <a href="#aee172420a332a222f34f9e9eaf6c5621">More...</a><br /></td></tr>
<tr class="separator:aee172420a332a222f34f9e9eaf6c5621"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Namespace for time/date related classes and functions. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aeee784c375bcc301727eab3fe8e67d03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeee784c375bcc301727eab3fe8e67d03">◆ </a></span>durationTo_hh_mm_ss()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::time::durationTo_hh_mm_ss </td>
<td>(</td>
<td class="paramtype">std::chrono::system_clock::duration </td>
<td class="paramname"><em>duration</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts duration to a time string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duration</td><td>Duration or time of day to format. Must be less than 24 hours </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Duration string in the format <code>hh:mm:ss</code> </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when <code>duration</code> longer than 24 hours. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aee172420a332a222f34f9e9eaf6c5621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee172420a332a222f34f9e9eaf6c5621">◆ </a></span>parseDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">system_clock::duration hueplusplus::time::parseDuration </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>hourMinSec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts time string to a duration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hourMinSec</td><td>Time/duration in the format <code>hh:mm:ss</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Duration (hours, minutes and seconds) from the string </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::invalid_argument</td><td>when integer conversion fails </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a84b6a46eb1f4a03ab7740104a8616007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84b6a46eb1f4a03ab7740104a8616007">◆ </a></span>parseTimestamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">system_clock::time_point hueplusplus::time::parseTimestamp </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>timestamp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a timestamp to a time_point. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>Timestamp from the local time zone in the format <code>YYYY-MM-DD</code><b>T</b><code>hh:mm:ss</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>time_point of the local system clock </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::invalid_argument</td><td>when integer conversion fails </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when time cannot be represented as time_point </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a31275be9b8ff39ee8445787b59ad1235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31275be9b8ff39ee8445787b59ad1235">◆ </a></span>parseUTCTimestamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::chrono::system_clock::time_point hueplusplus::time::parseUTCTimestamp </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>timestamp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts an UTC timestamp to a time_point. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timestamp</td><td>UTC Timestamp the format <code>YYYY-MM-DD</code><b>T</b><code>hh:mm:ss</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>time_point of the local system clock </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::invalid_argument</td><td>when integer conversion fails </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when time cannot be represented as time_point </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afd15eb6e086c8242a2e202536fa4c02b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd15eb6e086c8242a2e202536fa4c02b">◆ </a></span>timepointToTimestamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::time::timepointToTimestamp </td>
<td>(</td>
<td class="paramtype">std::chrono::system_clock::time_point </td>
<td class="paramname"><em>time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a time_point to a timestamp string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>Time to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Date and time in the format <code>YYYY-MM-DD</code><b>T</b><code>hh:mm:ss</code>.</dd></dl>
<p>Returns the time in the local time zone. </p><dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when time could not be converted </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>