acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
classace__button_1_1TimingStats.html (12112B)
      1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
      2 <html xmlns="http://www.w3.org/1999/xhtml">
      3 <head>
      4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
      5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
      6 <meta name="generator" content="Doxygen 1.8.13"/>
      7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
      8 <title>AceButton: ace_button::TimingStats Class Reference</title>
      9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
     10 <script type="text/javascript" src="jquery.js"></script>
     11 <script type="text/javascript" src="dynsections.js"></script>
     12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
     13 <script type="text/javascript" src="search/searchdata.js"></script>
     14 <script type="text/javascript" src="search/search.js"></script>
     15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
     16 </head>
     17 <body>
     18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
     19 <div id="titlearea">
     20 <table cellspacing="0" cellpadding="0">
     21  <tbody>
     22  <tr style="height: 56px;">
     23   <td id="projectalign" style="padding-left: 0.5em;">
     24    <div id="projectname">AceButton
     25    &#160;<span id="projectnumber">1.3.3</span>
     26    </div>
     27    <div id="projectbrief">An adjustable, compact, event-driven button library for Arduino.</div>
     28   </td>
     29  </tr>
     30  </tbody>
     31 </table>
     32 </div>
     33 <!-- end header part -->
     34 <!-- Generated by Doxygen 1.8.13 -->
     35 <script type="text/javascript">
     36 var searchBox = new SearchBox("searchBox", "search",false,'Search');
     37 </script>
     38 <script type="text/javascript" src="menudata.js"></script>
     39 <script type="text/javascript" src="menu.js"></script>
     40 <script type="text/javascript">
     41 $(function() {
     42   initMenu('',true,false,'search.php','Search');
     43   $(document).ready(function() { init_search(); });
     44 });
     45 </script>
     46 <div id="main-nav"></div>
     47 <!-- window showing the filter options -->
     48 <div id="MSearchSelectWindow"
     49      onmouseover="return searchBox.OnSearchSelectShow()"
     50      onmouseout="return searchBox.OnSearchSelectHide()"
     51      onkeydown="return searchBox.OnSearchSelectKey(event)">
     52 </div>
     53 
     54 <!-- iframe showing the search results (closed by default) -->
     55 <div id="MSearchResultsWindow">
     56 <iframe src="javascript:void(0)" frameborder="0" 
     57         name="MSearchResults" id="MSearchResults">
     58 </iframe>
     59 </div>
     60 
     61 <div id="nav-path" class="navpath">
     62   <ul>
     63 <li class="navelem"><b>ace_button</b></li><li class="navelem"><a class="el" href="classace__button_1_1TimingStats.html">TimingStats</a></li>  </ul>
     64 </div>
     65 </div><!-- top -->
     66 <div class="header">
     67   <div class="summary">
     68 <a href="#pub-methods">Public Member Functions</a> &#124;
     69 <a href="classace__button_1_1TimingStats-members.html">List of all members</a>  </div>
     70   <div class="headertitle">
     71 <div class="title">ace_button::TimingStats Class Reference</div>  </div>
     72 </div><!--header-->
     73 <div class="contents">
     74 <table class="memberdecls">
     75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
     76 Public Member Functions</h2></td></tr>
     77 <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>
     78 <tr class="memdesc:ad763ef53d333dd86964acd7b5458491b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad763ef53d333dd86964acd7b5458491b">More...</a><br /></td></tr>
     79 <tr class="separator:ad763ef53d333dd86964acd7b5458491b"><td class="memSeparator" colspan="2">&#160;</td></tr>
     80 <tr class="memitem:a1e53cdacce4a86a2e3c466512cdc6661"><td class="memItemLeft" align="right" valign="top"><a id="a1e53cdacce4a86a2e3c466512cdc6661"></a>
     81 void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
     82 <tr class="separator:a1e53cdacce4a86a2e3c466512cdc6661"><td class="memSeparator" colspan="2">&#160;</td></tr>
     83 <tr class="memitem:a6f1fbf56ed9dc9b87b1b709a91a397e9"><td class="memItemLeft" align="right" valign="top"><a id="a6f1fbf56ed9dc9b87b1b709a91a397e9"></a>
     84 uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getMax</b> () const</td></tr>
     85 <tr class="separator:a6f1fbf56ed9dc9b87b1b709a91a397e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
     86 <tr class="memitem:a6729f8db8e00f95637008fa26dd9be2c"><td class="memItemLeft" align="right" valign="top"><a id="a6729f8db8e00f95637008fa26dd9be2c"></a>
     87 uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getMin</b> () const</td></tr>
     88 <tr class="separator:a6729f8db8e00f95637008fa26dd9be2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
     89 <tr class="memitem:a3ae11745d54cc603a9c66fd18aa631be"><td class="memItemLeft" align="right" valign="top"><a id="a3ae11745d54cc603a9c66fd18aa631be"></a>
     90 uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getAvg</b> () const</td></tr>
     91 <tr class="separator:a3ae11745d54cc603a9c66fd18aa631be"><td class="memSeparator" colspan="2">&#160;</td></tr>
     92 <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>
     93 <tr class="memdesc:a04c9dbea755eafeed3bb7872d7fb0d24"><td class="mdescLeft">&#160;</td><td class="mdescRight">An exponential decay average.  <a href="#a04c9dbea755eafeed3bb7872d7fb0d24">More...</a><br /></td></tr>
     94 <tr class="separator:a04c9dbea755eafeed3bb7872d7fb0d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
     95 <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>
     96 <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>
     97 <tr class="separator:ad23641b3302acb7050317c8749febe3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
     98 <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>
     99 <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>
    100 <tr class="separator:a3eab5a6a7a43e1a565d91faf14b148b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    101 <tr class="memitem:a10d5cf8bd11da5e1d07ddc256b97a2ce"><td class="memItemLeft" align="right" valign="top"><a id="a10d5cf8bd11da5e1d07ddc256b97a2ce"></a>
    102 void&#160;</td><td class="memItemRight" valign="bottom"><b>update</b> (uint16_t duration)</td></tr>
    103 <tr class="separator:a10d5cf8bd11da5e1d07ddc256b97a2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
    104 </table>
    105 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    106 <div class="textblock">
    107 <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>
    108 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    109 <a id="ad763ef53d333dd86964acd7b5458491b"></a>
    110 <h2 class="memtitle"><span class="permalink"><a href="#ad763ef53d333dd86964acd7b5458491b">&#9670;&nbsp;</a></span>TimingStats()</h2>
    111 
    112 <div class="memitem">
    113 <div class="memproto">
    114 <table class="mlabels">
    115   <tr>
    116   <td class="mlabels-left">
    117       <table class="memname">
    118         <tr>
    119           <td class="memname">ace_button::TimingStats::TimingStats </td>
    120           <td>(</td>
    121           <td class="paramname"></td><td>)</td>
    122           <td></td>
    123         </tr>
    124       </table>
    125   </td>
    126   <td class="mlabels-right">
    127 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    128   </tr>
    129 </table>
    130 </div><div class="memdoc">
    131 
    132 <p>Constructor. </p>
    133 <p>Default copy-constructor and assignment operator ok. </p>
    134 
    135 <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>
    136 
    137 </div>
    138 </div>
    139 <h2 class="groupheader">Member Function Documentation</h2>
    140 <a id="ad23641b3302acb7050317c8749febe3d"></a>
    141 <h2 class="memtitle"><span class="permalink"><a href="#ad23641b3302acb7050317c8749febe3d">&#9670;&nbsp;</a></span>getCount()</h2>
    142 
    143 <div class="memitem">
    144 <div class="memproto">
    145 <table class="mlabels">
    146   <tr>
    147   <td class="mlabels-left">
    148       <table class="memname">
    149         <tr>
    150           <td class="memname">uint16_t ace_button::TimingStats::getCount </td>
    151           <td>(</td>
    152           <td class="paramname"></td><td>)</td>
    153           <td> const</td>
    154         </tr>
    155       </table>
    156   </td>
    157   <td class="mlabels-right">
    158 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    159   </tr>
    160 </table>
    161 </div><div class="memdoc">
    162 
    163 <p>Number of times update() was called since last reset. </p>
    164 
    165 <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>
    166 
    167 </div>
    168 </div>
    169 <a id="a3eab5a6a7a43e1a565d91faf14b148b2"></a>
    170 <h2 class="memtitle"><span class="permalink"><a href="#a3eab5a6a7a43e1a565d91faf14b148b2">&#9670;&nbsp;</a></span>getCounter()</h2>
    171 
    172 <div class="memitem">
    173 <div class="memproto">
    174 <table class="mlabels">
    175   <tr>
    176   <td class="mlabels-left">
    177       <table class="memname">
    178         <tr>
    179           <td class="memname">uint16_t ace_button::TimingStats::getCounter </td>
    180           <td>(</td>
    181           <td class="paramname"></td><td>)</td>
    182           <td> const</td>
    183         </tr>
    184       </table>
    185   </td>
    186   <td class="mlabels-right">
    187 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    188   </tr>
    189 </table>
    190 </div><div class="memdoc">
    191 
    192 <p>Number of times update() was called from the beginning of time. </p>
    193 <p>Never reset. This is useful to determining how many times update() was called since it was last checked from the client code. </p>
    194 
    195 <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>
    196 
    197 </div>
    198 </div>
    199 <a id="a04c9dbea755eafeed3bb7872d7fb0d24"></a>
    200 <h2 class="memtitle"><span class="permalink"><a href="#a04c9dbea755eafeed3bb7872d7fb0d24">&#9670;&nbsp;</a></span>getExpDecayAvg()</h2>
    201 
    202 <div class="memitem">
    203 <div class="memproto">
    204 <table class="mlabels">
    205   <tr>
    206   <td class="mlabels-left">
    207       <table class="memname">
    208         <tr>
    209           <td class="memname">uint16_t ace_button::TimingStats::getExpDecayAvg </td>
    210           <td>(</td>
    211           <td class="paramname"></td><td>)</td>
    212           <td> const</td>
    213         </tr>
    214       </table>
    215   </td>
    216   <td class="mlabels-right">
    217 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    218   </tr>
    219 </table>
    220 </div><div class="memdoc">
    221 
    222 <p>An exponential decay average. </p>
    223 
    224 <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>
    225 
    226 </div>
    227 </div>
    228 <hr/>The documentation for this class was generated from the following file:<ul>
    229 <li>/home/brian/dev/AceButton/src/ace_button/<a class="el" href="TimingStats_8h_source.html">TimingStats.h</a></li>
    230 </ul>
    231 </div><!-- contents -->
    232 <!-- start footer part -->
    233 <hr class="footer"/><address class="footer"><small>
    234 Generated by &#160;<a href="http://www.doxygen.org/index.html">
    235 <img class="footer" src="doxygen.png" alt="doxygen"/>
    236 </a> 1.8.13
    237 </small></address>
    238 </body>
    239 </html>