acidvegas/acid-drop
acidvegas/acid-drop
1
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases 1 Wiki Activity
0289343061
acid-drop/lib/AceButton/docs/html/classace__button_1_1TimingStats.html
acidvegas 96c6e96d12
Initial commit
2024-05-23 18:42:03 -04:00

240 lines
12 KiB
HTML
Raw Blame History

<!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: ace_button::TimingStats 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">AceButton
&#160;<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"><b>ace_button</b></li><li class="navelem"><a class="el" href="classace__button_1_1TimingStats.html">TimingStats</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classace__button_1_1TimingStats-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ace_button::TimingStats Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:ad763ef53d333dd86964acd7b5458491b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1TimingStats.html#ad763ef53d333dd86964acd7b5458491b">TimingStats</a> ()</td></tr>
<tr class="memdesc:ad763ef53d333dd86964acd7b5458491b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#ad763ef53d333dd86964acd7b5458491b">More...</a><br /></td></tr>
<tr class="separator:ad763ef53d333dd86964acd7b5458491b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e53cdacce4a86a2e3c466512cdc6661"><td class="memItemLeft" align="right" valign="top"><a id="a1e53cdacce4a86a2e3c466512cdc6661"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a1e53cdacce4a86a2e3c466512cdc6661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f1fbf56ed9dc9b87b1b709a91a397e9"><td class="memItemLeft" align="right" valign="top"><a id="a6f1fbf56ed9dc9b87b1b709a91a397e9"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getMax</b> () const</td></tr>
<tr class="separator:a6f1fbf56ed9dc9b87b1b709a91a397e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6729f8db8e00f95637008fa26dd9be2c"><td class="memItemLeft" align="right" valign="top"><a id="a6729f8db8e00f95637008fa26dd9be2c"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getMin</b> () const</td></tr>
<tr class="separator:a6729f8db8e00f95637008fa26dd9be2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ae11745d54cc603a9c66fd18aa631be"><td class="memItemLeft" align="right" valign="top"><a id="a3ae11745d54cc603a9c66fd18aa631be"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getAvg</b> () const</td></tr>
<tr class="separator:a3ae11745d54cc603a9c66fd18aa631be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04c9dbea755eafeed3bb7872d7fb0d24"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1TimingStats.html#a04c9dbea755eafeed3bb7872d7fb0d24">getExpDecayAvg</a> () const</td></tr>
<tr class="memdesc:a04c9dbea755eafeed3bb7872d7fb0d24"><td class="mdescLeft">&#160;</td><td class="mdescRight">An exponential decay average. <a href="#a04c9dbea755eafeed3bb7872d7fb0d24">More...</a><br /></td></tr>
<tr class="separator:a04c9dbea755eafeed3bb7872d7fb0d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad23641b3302acb7050317c8749febe3d"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1TimingStats.html#ad23641b3302acb7050317c8749febe3d">getCount</a> () const</td></tr>
<tr class="memdesc:ad23641b3302acb7050317c8749febe3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of times update() was called since last reset. <a href="#ad23641b3302acb7050317c8749febe3d">More...</a><br /></td></tr>
<tr class="separator:ad23641b3302acb7050317c8749febe3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3eab5a6a7a43e1a565d91faf14b148b2"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classace__button_1_1TimingStats.html#a3eab5a6a7a43e1a565d91faf14b148b2">getCounter</a> () const</td></tr>
<tr class="memdesc:a3eab5a6a7a43e1a565d91faf14b148b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of times update() was called from the beginning of time. <a href="#a3eab5a6a7a43e1a565d91faf14b148b2">More...</a><br /></td></tr>
<tr class="separator:a3eab5a6a7a43e1a565d91faf14b148b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10d5cf8bd11da5e1d07ddc256b97a2ce"><td class="memItemLeft" align="right" valign="top"><a id="a10d5cf8bd11da5e1d07ddc256b97a2ce"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>update</b> (uint16_t duration)</td></tr>
<tr class="separator:a10d5cf8bd11da5e1d07ddc256b97a2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="TimingStats_8h_source.html#l00032">32</a> of file <a class="el" href="TimingStats_8h_source.html">TimingStats.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad763ef53d333dd86964acd7b5458491b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad763ef53d333dd86964acd7b5458491b">&#9670;&nbsp;</a></span>TimingStats()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ace_button::TimingStats::TimingStats </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Default copy-constructor and assignment operator ok. </p>
<p class="definition">Definition at line <a class="el" href="TimingStats_8h_source.html#l00035">35</a> of file <a class="el" href="TimingStats_8h_source.html">TimingStats.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad23641b3302acb7050317c8749febe3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad23641b3302acb7050317c8749febe3d">&#9670;&nbsp;</a></span>getCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t ace_button::TimingStats::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of times update() was called since last reset. </p>
<p class="definition">Definition at line <a class="el" href="TimingStats_8h_source.html#l00057">57</a> of file <a class="el" href="TimingStats_8h_source.html">TimingStats.h</a>.</p>
</div>
</div>
<a id="a3eab5a6a7a43e1a565d91faf14b148b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eab5a6a7a43e1a565d91faf14b148b2">&#9670;&nbsp;</a></span>getCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t ace_button::TimingStats::getCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of times update() was called from the beginning of time. </p>
<p>Never reset. This is useful to determining how many times update() was called since it was last checked from the client code. </p>
<p class="definition">Definition at line <a class="el" href="TimingStats_8h_source.html#l00064">64</a> of file <a class="el" href="TimingStats_8h_source.html">TimingStats.h</a>.</p>
</div>
</div>
<a id="a04c9dbea755eafeed3bb7872d7fb0d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04c9dbea755eafeed3bb7872d7fb0d24">&#9670;&nbsp;</a></span>getExpDecayAvg()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t ace_button::TimingStats::getExpDecayAvg </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An exponential decay average. </p>
<p class="definition">Definition at line <a class="el" href="TimingStats_8h_source.html#l00054">54</a> of file <a class="el" href="TimingStats_8h_source.html">TimingStats.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/brian/dev/AceButton/src/ace_button/<a class="el" href="TimingStats_8h_source.html">TimingStats.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink