tRacket-sensor

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tRacket Sensor: Blinker 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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">tRacket Sensor<span id="projectnumber">&#160;0.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classBlinker-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Blinker Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Automates the blinking of the board's LED indicator.  
 <a href="classBlinker.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="blinker_8h_source.html">blinker.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Blinker:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classBlinker.png" alt=""/>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8b59cdda787453b77f20791edc7c9ec5" id="r_a8b59cdda787453b77f20791edc7c9ec5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBlinker.html#a8b59cdda787453b77f20791edc7c9ec5">Blinker</a> (unsigned ms)</td></tr>
<tr class="memdesc:a8b59cdda787453b77f20791edc7c9ec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a timer to toggle the LED.  <br /></td></tr>
<tr class="separator:a8b59cdda787453b77f20791edc7c9ec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fe7feaac0ac3ca4cf40239849058c5b" id="r_a2fe7feaac0ac3ca4cf40239849058c5b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBlinker.html#a2fe7feaac0ac3ca4cf40239849058c5b">~Blinker</a> ()</td></tr>
<tr class="memdesc:a2fe7feaac0ac3ca4cf40239849058c5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detaches the LED toggle routine.  <br /></td></tr>
<tr class="separator:a2fe7feaac0ac3ca4cf40239849058c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:af75759cb22e5a665ec8dd8d52c640e18" id="r_af75759cb22e5a665ec8dd8d52c640e18"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBlinker.html#af75759cb22e5a665ec8dd8d52c640e18">callback</a> (int *st)</td></tr>
<tr class="memdesc:af75759cb22e5a665ec8dd8d52c640e18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ticker callback to toggle the LED every time interval.  <br /></td></tr>
<tr class="separator:af75759cb22e5a665ec8dd8d52c640e18"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a968e8707f98056473fb3f9c3fea3d7b2" id="r_a968e8707f98056473fb3f9c3fea3d7b2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBlinker.html#a968e8707f98056473fb3f9c3fea3d7b2">state</a> = HIGH</td></tr>
<tr class="memdesc:a968e8707f98056473fb3f9c3fea3d7b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">State of the LED.  <br /></td></tr>
<tr class="separator:a968e8707f98056473fb3f9c3fea3d7b2"><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>Automates the blinking of the board's LED indicator. </p>

<p class="definition">Definition at line <a class="el" href="blinker_8h_source.html#l00029">29</a> of file <a class="el" href="blinker_8h_source.html">blinker.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8b59cdda787453b77f20791edc7c9ec5" name="a8b59cdda787453b77f20791edc7c9ec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b59cdda787453b77f20791edc7c9ec5">&#9670;&#160;</a></span>Blinker()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Blinker::Blinker </td>
          <td>(</td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>ms</em></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>Starts a timer to toggle the LED. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ms</td><td>Milliseconds to delay between toggles. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="blinker_8h_source.html#l00036">36</a> of file <a class="el" href="blinker_8h_source.html">blinker.h</a>.</p>

</div>
</div>
<a id="a2fe7feaac0ac3ca4cf40239849058c5b" name="a2fe7feaac0ac3ca4cf40239849058c5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fe7feaac0ac3ca4cf40239849058c5b">&#9670;&#160;</a></span>~Blinker()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Blinker::~Blinker </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>Detaches the LED toggle routine. </p>

<p class="definition">Definition at line <a class="el" href="blinker_8h_source.html#l00045">45</a> of file <a class="el" href="blinker_8h_source.html">blinker.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af75759cb22e5a665ec8dd8d52c640e18" name="af75759cb22e5a665ec8dd8d52c640e18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af75759cb22e5a665ec8dd8d52c640e18">&#9670;&#160;</a></span>callback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void Blinker::callback </td>
          <td>(</td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>st</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Ticker callback to toggle the LED every time interval. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">st</td><td>Pointer to the active <a class="el" href="classBlinker.html" title="Automates the blinking of the board&#39;s LED indicator.">Blinker</a> instance's state </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="blinker_8h_source.html#l00058">58</a> of file <a class="el" href="blinker_8h_source.html">blinker.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a968e8707f98056473fb3f9c3fea3d7b2" name="a968e8707f98056473fb3f9c3fea3d7b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a968e8707f98056473fb3f9c3fea3d7b2">&#9670;&#160;</a></span>state</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int Blinker::state = HIGH</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>State of the LED. </p>

<p class="definition">Definition at line <a class="el" href="blinker_8h_source.html#l00052">52</a> of file <a class="el" href="blinker_8h_source.html">blinker.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>noisemeter-device/<a class="el" href="blinker_8h_source.html">blinker.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>