-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTimer_8h_source.html
115 lines (113 loc) · 10.7 KB
/
Timer_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
<!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: Timer.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">Timer.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Timer_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 TIMER_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define TIMER_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classTimer.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="classTimer.html">Timer</a></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="classTimer.html#a1540f5de6fc1684bcef402776f995ff1">Timer</a>();</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">void</span> <a class="code" href="classTimer.html#a4b56fa95f68f4aabbd397dcce1d97636">start</a>();</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">void</span> stop(){m_isRunning = <span class="keyword">false</span>;}</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordtype">bool</span> running()<span class="keyword">const </span>{<span class="keywordflow">return</span> m_isRunning;}</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">bool</span> <a class="code" href="classTimer.html#a12f50720d60320b863a024329d88017a">expired</a>(T msPeriod); <span class="comment">// returns true only once after expiration, then stops running</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  T <a class="code" href="classTimer.html#a084d353cdec752e296a0bd06c39f707a">elapsed</a>(); <span class="comment">// returns the time in milliseconds since the timer was started or 0 otherwise</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">bool</span> expired_cont(T msPeriod); <span class="comment">// return true when continuosly when expired / not running</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  T started()<span class="keyword">const </span>{<span class="keywordflow">return</span> m_started;}</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">bool</span> m_isRunning;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  T m_started;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> };</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#if __cplusplus>=201103L</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="Timer_8h.html#a122624b48597734c53c24ad2b1a0a000"> 40</a></span> <span class="keyword">using</span> <a class="code" href="classTimer.html">LongTimer</a> = <a class="code" href="classTimer.html">Timer<unsigned long></a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">typedef</span> <a class="code" href="classTimer.html">Timer<unsigned long></a> <a class="code" href="Timer_8h.html#a122624b48597734c53c24ad2b1a0a000">LongTimer</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#if __cplusplus>=201103L</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="Timer_8h.html#a41ba10bd5180e91fa2248d0d56166621"> 50</a></span> <span class="keyword">using</span> <a class="code" href="classTimer.html">ShortTimer</a> = <a class="code" href="classTimer.html">Timer<unsigned short></a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">typedef</span> <a class="code" href="classTimer.html">Timer<unsigned short></a> <a class="code" href="Timer_8h.html#a41ba10bd5180e91fa2248d0d56166621">ShortTimer</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#endif</span></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> <span class="preprocessor">#endif </span><span class="comment">/* TIMER_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aTimer_8h_html_a122624b48597734c53c24ad2b1a0a000"><div class="ttname"><a href="Timer_8h.html#a122624b48597734c53c24ad2b1a0a000">LongTimer</a></div><div class="ttdeci">Timer< unsigned long > LongTimer</div><div class="ttdoc">Timer unsigned long specialization.</div><div class="ttdef"><b>Definition:</b> Timer.h:40</div></div>
<div class="ttc" id="aTimer_8h_html_a41ba10bd5180e91fa2248d0d56166621"><div class="ttname"><a href="Timer_8h.html#a41ba10bd5180e91fa2248d0d56166621">ShortTimer</a></div><div class="ttdeci">Timer< unsigned short > ShortTimer</div><div class="ttdoc">Timer unsigned short specialization.</div><div class="ttdef"><b>Definition:</b> Timer.h:50</div></div>
<div class="ttc" id="aclassTimer_html"><div class="ttname"><a href="classTimer.html">Timer</a></div><div class="ttdoc">simple timer</div><div class="ttdef"><b>Definition:</b> Timer.h:18</div></div>
<div class="ttc" id="aclassTimer_html_a084d353cdec752e296a0bd06c39f707a"><div class="ttname"><a href="classTimer.html#a084d353cdec752e296a0bd06c39f707a">Timer::elapsed</a></div><div class="ttdeci">T elapsed()</div><div class="ttdoc">Ticks since the timer was started.</div><div class="ttdef"><b>Definition:</b> Timer.cpp:76</div></div>
<div class="ttc" id="aclassTimer_html_a12f50720d60320b863a024329d88017a"><div class="ttname"><a href="classTimer.html#a12f50720d60320b863a024329d88017a">Timer::expired</a></div><div class="ttdeci">bool expired(T 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_a1540f5de6fc1684bcef402776f995ff1"><div class="ttname"><a href="classTimer.html#a1540f5de6fc1684bcef402776f995ff1">Timer::Timer</a></div><div class="ttdeci">Timer()</div><div class="ttdoc">construct Timer</div><div class="ttdef"><b>Definition:</b> Timer.cpp:16</div></div>
<div class="ttc" id="aclassTimer_html_a4b56fa95f68f4aabbd397dcce1d97636"><div class="ttname"><a href="classTimer.html#a4b56fa95f68f4aabbd397dcce1d97636">Timer::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><!-- 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>