-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTimerRemaining_8h_source.html
119 lines (117 loc) · 11.2 KB
/
TimerRemaining_8h_source.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
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Prusa3d Marlin fork: TimerRemaining.h Source File</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">Prusa3d Marlin fork
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">TimerRemaining.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="TimerRemaining_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef TIMERREMAINING_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define TIMERREMAINING_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="Timer_8h.html">Timer.h</a>"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "Arduino.h"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="system__timer_8h.html">system_timer.h</a>"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <limits.h></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classTimerRemaining.html"> 14</a></span> <span class="keyword">class </span><a class="code" href="classTimerRemaining.html">TimerRemaining</a> : <span class="keyword">public</span> <a class="code" href="classTimer.html">LongTimer</a></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="classTimerRemaining.html">TimerRemaining</a>() : m_period(){}</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">void</span> start() = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">bool</span> <a class="code" href="classTimerRemaining.html#a91994c3a0ae8959601aff057c9cc7571">expired</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> msPeriod) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classTimerRemaining.html#a43492433c57e9868c7d409e98873cf5d"> 24</a></span>  <span class="keywordtype">void</span> <a class="code" href="classTimerRemaining.html#a43492433c57e9868c7d409e98873cf5d">start</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> msPeriod)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  m_period = msPeriod;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classTimer.html#a4b56fa95f68f4aabbd397dcce1d97636">LongTimer::start</a>();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classTimerRemaining.html#ad7759ecbfe4337c63d682407f4c9c090"> 36</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimerRemaining.html#ad7759ecbfe4337c63d682407f4c9c090">remaining</a>()</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">if</span> (!running()) <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">if</span> (<a class="code" href="classTimerRemaining.html#a91994c3a0ae8959601aff057c9cc7571">expired</a>()) <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> now = _millis();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> (started() + m_period - now);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classTimerRemaining.html#a91994c3a0ae8959601aff057c9cc7571"> 48</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classTimerRemaining.html#a91994c3a0ae8959601aff057c9cc7571">expired</a>()</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> <a class="code" href="classTimer.html#a12f50720d60320b863a024329d88017a">LongTimer::expired</a>(m_period);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_period; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif </span><span class="comment">// ifndef TIMERREMAINING_H</span></div>
<div class="ttc" id="aTimer_8h_html"><div class="ttname"><a href="Timer_8h.html">Timer.h</a></div></div>
<div class="ttc" id="aclassTimerRemaining_html"><div class="ttname"><a href="classTimerRemaining.html">TimerRemaining</a></div><div class="ttdef"><b>Definition:</b> TimerRemaining.h:15</div></div>
<div class="ttc" id="aclassTimerRemaining_html_a43492433c57e9868c7d409e98873cf5d"><div class="ttname"><a href="classTimerRemaining.html#a43492433c57e9868c7d409e98873cf5d">TimerRemaining::start</a></div><div class="ttdeci">void start(unsigned long msPeriod)</div><div class="ttdoc">Start timer.</div><div class="ttdef"><b>Definition:</b> TimerRemaining.h:24</div></div>
<div class="ttc" id="aclassTimerRemaining_html_a91994c3a0ae8959601aff057c9cc7571"><div class="ttname"><a href="classTimerRemaining.html#a91994c3a0ae8959601aff057c9cc7571">TimerRemaining::expired</a></div><div class="ttdeci">bool expired()</div><div class="ttdoc">Timer has expired.</div><div class="ttdef"><b>Definition:</b> TimerRemaining.h:48</div></div>
<div class="ttc" id="aclassTimerRemaining_html_ad7759ecbfe4337c63d682407f4c9c090"><div class="ttname"><a href="classTimerRemaining.html#ad7759ecbfe4337c63d682407f4c9c090">TimerRemaining::remaining</a></div><div class="ttdeci">unsigned long remaining()</div><div class="ttdoc">Time remaining to expiration.</div><div class="ttdef"><b>Definition:</b> TimerRemaining.h:36</div></div>
<div class="ttc" id="aclassTimer_html"><div class="ttname"><a href="classTimer.html">Timer< unsigned long ></a></div></div>
<div class="ttc" id="aclassTimer_html_a12f50720d60320b863a024329d88017a"><div class="ttname"><a href="classTimer.html#a12f50720d60320b863a024329d88017a">Timer< unsigned long >::expired</a></div><div class="ttdeci">bool expired(unsigned long msPeriod)</div><div class="ttdoc">Timer has expired.</div><div class="ttdef"><b>Definition:</b> Timer.cpp:44</div></div>
<div class="ttc" id="aclassTimer_html_a4b56fa95f68f4aabbd397dcce1d97636"><div class="ttname"><a href="classTimer.html#a4b56fa95f68f4aabbd397dcce1d97636">Timer< unsigned long >::start</a></div><div class="ttdeci">void start()</div><div class="ttdoc">Start timer.</div><div class="ttdef"><b>Definition:</b> Timer.cpp:24</div></div>
<div class="ttc" id="asystem__timer_8h_html"><div class="ttname"><a href="system__timer_8h.html">system_timer.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>