-
Notifications
You must be signed in to change notification settings - Fork 849
/
Copy pathclassTimerMs.html
238 lines (219 loc) · 11.1 KB
/
classTimerMs.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IRremoteESP8266: TimerMs 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">IRremoteESP8266
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classTimerMs-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TimerMs Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class offers a simple counter in milli-seconds since instantiated.
<a href="classTimerMs.html#details">More...</a></p>
<p><code>#include <<a class="el" href="IRtimer_8h_source.html">IRtimer.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:a7bf7f8d2fcf76b27b34ea4705810eef5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimerMs.html#a7bf7f8d2fcf76b27b34ea4705810eef5">TimerMs</a> ()</td></tr>
<tr class="memdesc:a7bf7f8d2fcf76b27b34ea4705810eef5"><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="classTimerMs.html#a7bf7f8d2fcf76b27b34ea4705810eef5">More...</a><br /></td></tr>
<tr class="separator:a7bf7f8d2fcf76b27b34ea4705810eef5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25ab025793a4d432e7d4180cbd31157b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimerMs.html#a25ab025793a4d432e7d4180cbd31157b">reset</a> ()</td></tr>
<tr class="memdesc:a25ab025793a4d432e7d4180cbd31157b"><td class="mdescLeft"> </td><td class="mdescRight">Resets the <a class="el" href="classTimerMs.html" title="This class offers a simple counter in milli-seconds since instantiated.">TimerMs</a> object. I.e. The counter starts again from now. <a href="classTimerMs.html#a25ab025793a4d432e7d4180cbd31157b">More...</a><br /></td></tr>
<tr class="separator:a25ab025793a4d432e7d4180cbd31157b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4aa759c58727393f69863b3461dfc09"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimerMs.html#ad4aa759c58727393f69863b3461dfc09">elapsed</a> ()</td></tr>
<tr class="memdesc:ad4aa759c58727393f69863b3461dfc09"><td class="mdescLeft"> </td><td class="mdescRight">Calculate how many milliseconds have elapsed since the timer was started. <a href="classTimerMs.html#ad4aa759c58727393f69863b3461dfc09">More...</a><br /></td></tr>
<tr class="separator:ad4aa759c58727393f69863b3461dfc09"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a77bfc23a029a9172c3dbac03f746b0cb"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimerMs.html#a77bfc23a029a9172c3dbac03f746b0cb">add</a> (uint32_t msecs)</td></tr>
<tr class="memdesc:a77bfc23a029a9172c3dbac03f746b0cb"><td class="mdescLeft"> </td><td class="mdescRight">Add time to the timer to simulate elapsed time. <a href="classTimerMs.html#a77bfc23a029a9172c3dbac03f746b0cb">More...</a><br /></td></tr>
<tr class="separator:a77bfc23a029a9172c3dbac03f746b0cb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a15ad2e08a5931397391d48f040722f65"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimerMs.html#a15ad2e08a5931397391d48f040722f65">start</a></td></tr>
<tr class="memdesc:a15ad2e08a5931397391d48f040722f65"><td class="mdescLeft"> </td><td class="mdescRight">Time in mSeconds when the class was instantiated/reset. <a href="classTimerMs.html#a15ad2e08a5931397391d48f040722f65">More...</a><br /></td></tr>
<tr class="separator:a15ad2e08a5931397391d48f040722f65"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class offers a simple counter in milli-seconds since instantiated. </p>
<dl class="section note"><dt>Note</dt><dd>Handles when the system timer wraps around (once). </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7bf7f8d2fcf76b27b34ea4705810eef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bf7f8d2fcf76b27b34ea4705810eef5">◆ </a></span>TimerMs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TimerMs::TimerMs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Class constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a77bfc23a029a9172c3dbac03f746b0cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77bfc23a029a9172c3dbac03f746b0cb">◆ </a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TimerMs::add </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>msecs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add time to the timer to simulate elapsed time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msecs</td><td>Nr. of mSeconds to be added. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Only used in unit testing. </dd></dl>
</div>
</div>
<a id="ad4aa759c58727393f69863b3461dfc09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4aa759c58727393f69863b3461dfc09">◆ </a></span>elapsed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t TimerMs::elapsed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate how many milliseconds have elapsed since the timer was started. </p>
<dl class="section return"><dt>Returns</dt><dd>Nr. of milliseconds. </dd></dl>
</div>
</div>
<a id="a25ab025793a4d432e7d4180cbd31157b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25ab025793a4d432e7d4180cbd31157b">◆ </a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimerMs::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the <a class="el" href="classTimerMs.html" title="This class offers a simple counter in milli-seconds since instantiated.">TimerMs</a> object. I.e. The counter starts again from now. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a15ad2e08a5931397391d48f040722f65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15ad2e08a5931397391d48f040722f65">◆ </a></span>start</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t TimerMs::start</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Time in mSeconds when the class was instantiated/reset. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="IRtimer_8h_source.html">IRtimer.h</a></li>
<li>src/<a class="el" href="IRtimer_8cpp.html">IRtimer.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.17
</small></address>
</body>
</html>