86 lines
16 KiB
HTML
86 lines
16 KiB
HTML
<!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>AceButton: /home/brian/dev/AceButton/src/ace_button/TimingStats.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">AceButton
|
|
 <span id="projectnumber">1.3.3</span>
|
|
</div>
|
|
<div id="projectbrief">An adjustable, compact, event-driven button library for Arduino.</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ebbe9b537c0e01d975153fa119b09658.html">ace_button</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">TimingStats.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">MIT License</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">Copyright (c) 2018 Brian T. Park</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">of this software and associated documentation files (the "Software"), to deal</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef ACE_BUTTON_TIMING_STATS_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define ACE_BUTTON_TIMING_STATS_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespaceace__button.html">ace_button</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classace__button_1_1TimingStats.html">TimingStats</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b"> 35</a></span>  <a class="code" href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b">TimingStats</a>(): mCounter(0) {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  reset();</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> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> reset() {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  mExpDecayAvg = 0;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  mMin = UINT16_MAX;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  mMax = 0;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  mSum = 0;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  mCount = 0;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint16_t getMax()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMax; }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  uint16_t getMin()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMin; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  uint16_t getAvg()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mCount > 0) ? mSum / mCount : 0; }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24"> 54</a></span>  uint16_t <a class="code" href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24">getExpDecayAvg</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mExpDecayAvg; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d"> 57</a></span>  uint16_t <a class="code" href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d">getCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCount; }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2"> 64</a></span>  uint16_t <a class="code" href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2">getCounter</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCounter; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> update(uint16_t duration) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  mCount++;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  mCounter++;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  mSum += duration;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (duration < mMin) {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  mMin = duration;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">if</span> (duration > mMax) {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  mMax = duration;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  mExpDecayAvg = (mExpDecayAvg + duration) / 2;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  uint16_t mExpDecayAvg;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  uint16_t mMin;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  uint16_t mMax;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  uint32_t mSum;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  uint16_t mCount;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  uint16_t mCounter;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> };</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classace__button_1_1TimingStats_html_a04c9dbea755eafeed3bb7872d7fb0d24"><div class="ttname"><a href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24">ace_button::TimingStats::getExpDecayAvg</a></div><div class="ttdeci">uint16_t getExpDecayAvg() const</div><div class="ttdoc">An exponential decay average. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00054">TimingStats.h:54</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1TimingStats_html"><div class="ttname"><a href="classace__button_1_1TimingStats.html">ace_button::TimingStats</a></div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00032">TimingStats.h:32</a></div></div>
|
|
<div class="ttc" id="namespaceace__button_html"><div class="ttname"><a href="namespaceace__button.html">ace_button</a></div><div class="ttdef"><b>Definition:</b> <a href="AceButton_8cpp_source.html#l00028">AceButton.cpp:28</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1TimingStats_html_ad763ef53d333dd86964acd7b5458491b"><div class="ttname"><a href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b">ace_button::TimingStats::TimingStats</a></div><div class="ttdeci">TimingStats()</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00035">TimingStats.h:35</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1TimingStats_html_ad23641b3302acb7050317c8749febe3d"><div class="ttname"><a href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d">ace_button::TimingStats::getCount</a></div><div class="ttdeci">uint16_t getCount() const</div><div class="ttdoc">Number of times update() was called since last reset. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00057">TimingStats.h:57</a></div></div>
|
|
<div class="ttc" id="classace__button_1_1TimingStats_html_a3eab5a6a7a43e1a565d91faf14b148b2"><div class="ttname"><a href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2">ace_button::TimingStats::getCounter</a></div><div class="ttdeci">uint16_t getCounter() const</div><div class="ttdoc">Number of times update() was called from the beginning of time. </div><div class="ttdef"><b>Definition:</b> <a href="TimingStats_8h_source.html#l00064">TimingStats.h:64</a></div></div>
|
|
</div><!-- fragment --></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>
|