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: noisemeter-device/data-packet.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 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_640a2e73a782d0e2711002117fcf2017.html">noisemeter-device</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">data-packet.h</div></div>
</div><!--header-->
<div class="contents">
<a href="data-packet_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">/* noisemeter-device - Firmware for CivicTechTO&#39;s Noisemeter Device</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Copyright (C) 2024  Clyne Sullivan</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> *</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#ifndef DATAPACKET_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#define DATAPACKET_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="timestamp_8h.html">timestamp.h</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structDataPacket.html">   29</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structDataPacket.html">DataPacket</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structDataPacket.html#abbf7bd0fe4fe3a4b9b2c2ded6bca3808">   34</a></span>    <span class="keyword">constexpr</span> <a class="code hl_function" href="structDataPacket.html#abbf7bd0fe4fe3a4b9b2c2ded6bca3808">DataPacket</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structDataPacket.html#a917ddce56b4fc02243dca0d993278355">   40</a></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="structDataPacket.html#a917ddce56b4fc02243dca0d993278355">add</a>(<span class="keywordtype">float</span> sample) <span class="keyword">noexcept</span> {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>        <a class="code hl_variable" href="structDataPacket.html#adc361a3409ff9fe2898e8196bf80ddd5">count</a>++;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>        <a class="code hl_variable" href="structDataPacket.html#a8cd7df92da2eea9abb845f87f98271cc">minimum</a> = std::min(<a class="code hl_variable" href="structDataPacket.html#a8cd7df92da2eea9abb845f87f98271cc">minimum</a>, sample);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>        <a class="code hl_variable" href="structDataPacket.html#a932840e12a30bfc175a87573bc7da29a">maximum</a> = std::max(<a class="code hl_variable" href="structDataPacket.html#a932840e12a30bfc175a87573bc7da29a">maximum</a>, sample);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>        <a class="code hl_variable" href="structDataPacket.html#a468b65a654fc379b4099ef948467c117">average</a> += (sample - <a class="code hl_variable" href="structDataPacket.html#a468b65a654fc379b4099ef948467c117">average</a>) / <a class="code hl_variable" href="structDataPacket.html#adc361a3409ff9fe2898e8196bf80ddd5">count</a>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>    }</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structDataPacket.html#adc361a3409ff9fe2898e8196bf80ddd5">   48</a></span>    <span class="keywordtype">int</span> <a class="code hl_variable" href="structDataPacket.html#adc361a3409ff9fe2898e8196bf80ddd5">count</a> = 0;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structDataPacket.html#a8cd7df92da2eea9abb845f87f98271cc">   51</a></span>    <span class="keywordtype">float</span> <a class="code hl_variable" href="structDataPacket.html#a8cd7df92da2eea9abb845f87f98271cc">minimum</a> = 999.f;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structDataPacket.html#a932840e12a30bfc175a87573bc7da29a">   54</a></span>    <span class="keywordtype">float</span> <a class="code hl_variable" href="structDataPacket.html#a932840e12a30bfc175a87573bc7da29a">maximum</a> = 0.f;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="structDataPacket.html#a468b65a654fc379b4099ef948467c117">   57</a></span>    <span class="keywordtype">float</span> <a class="code hl_variable" href="structDataPacket.html#a468b65a654fc379b4099ef948467c117">average</a> = 0.f;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structDataPacket.html#aa4baf5b92cbefdd6e16365b7b525e890">   64</a></span>    <a class="code hl_class" href="classTimestamp.html">Timestamp</a> <a class="code hl_variable" href="structDataPacket.html#aa4baf5b92cbefdd6e16365b7b525e890">timestamp</a> = <a class="code hl_function" href="classTimestamp.html#a66f54270c50d2435a310c6a459e3b747">Timestamp::invalidTimestamp</a>();</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>};</div>
</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#endif </span><span class="comment">// DATAPACKET_H</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
<div class="ttc" id="aclassTimestamp_html"><div class="ttname"><a href="classTimestamp.html">Timestamp</a></div><div class="ttdoc">Timestamping facility that uses NTP to provide accurate date and time.</div><div class="ttdef"><b>Definition</b> <a href="timestamp_8h_source.html#l00036">timestamp.h:37</a></div></div>
<div class="ttc" id="aclassTimestamp_html_a66f54270c50d2435a310c6a459e3b747"><div class="ttname"><a href="classTimestamp.html#a66f54270c50d2435a310c6a459e3b747">Timestamp::invalidTimestamp</a></div><div class="ttdeci">static Timestamp invalidTimestamp()</div><div class="ttdoc">Provides a timestamp that is guaranteed to be invalid.</div><div class="ttdef"><b>Definition</b> <a href="timestamp_8h_source.html#l00100">timestamp.h:100</a></div></div>
<div class="ttc" id="astructDataPacket_html"><div class="ttname"><a href="structDataPacket.html">DataPacket</a></div><div class="ttdoc">Stores data points included in an uploaded &quot;measurement&quot;.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00029">data-packet.h:30</a></div></div>
<div class="ttc" id="astructDataPacket_html_a468b65a654fc379b4099ef948467c117"><div class="ttname"><a href="structDataPacket.html#a468b65a654fc379b4099ef948467c117">DataPacket::average</a></div><div class="ttdeci">float average</div><div class="ttdoc">Average decibel value of the aggregated points.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00057">data-packet.h:57</a></div></div>
<div class="ttc" id="astructDataPacket_html_a8cd7df92da2eea9abb845f87f98271cc"><div class="ttname"><a href="structDataPacket.html#a8cd7df92da2eea9abb845f87f98271cc">DataPacket::minimum</a></div><div class="ttdeci">float minimum</div><div class="ttdoc">Minimum decibel value within the aggregated points.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00051">data-packet.h:51</a></div></div>
<div class="ttc" id="astructDataPacket_html_a917ddce56b4fc02243dca0d993278355"><div class="ttname"><a href="structDataPacket.html#a917ddce56b4fc02243dca0d993278355">DataPacket::add</a></div><div class="ttdeci">void add(float sample) noexcept</div><div class="ttdoc">Factors a sample into the packet's data points.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00040">data-packet.h:40</a></div></div>
<div class="ttc" id="astructDataPacket_html_a932840e12a30bfc175a87573bc7da29a"><div class="ttname"><a href="structDataPacket.html#a932840e12a30bfc175a87573bc7da29a">DataPacket::maximum</a></div><div class="ttdeci">float maximum</div><div class="ttdoc">Maximum decibel value within the aggregated points.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00054">data-packet.h:54</a></div></div>
<div class="ttc" id="astructDataPacket_html_aa4baf5b92cbefdd6e16365b7b525e890"><div class="ttname"><a href="structDataPacket.html#aa4baf5b92cbefdd6e16365b7b525e890">DataPacket::timestamp</a></div><div class="ttdeci">Timestamp timestamp</div><div class="ttdoc">Timestamp to indicate the ending time point of this DataPacket's aggregation.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00064">data-packet.h:64</a></div></div>
<div class="ttc" id="astructDataPacket_html_abbf7bd0fe4fe3a4b9b2c2ded6bca3808"><div class="ttname"><a href="structDataPacket.html#abbf7bd0fe4fe3a4b9b2c2ded6bca3808">DataPacket::DataPacket</a></div><div class="ttdeci">constexpr DataPacket()=default</div><div class="ttdoc">Creates a new DataPacket with sane defaults and an invalid timestamp.</div></div>
<div class="ttc" id="astructDataPacket_html_adc361a3409ff9fe2898e8196bf80ddd5"><div class="ttname"><a href="structDataPacket.html#adc361a3409ff9fe2898e8196bf80ddd5">DataPacket::count</a></div><div class="ttdeci">int count</div><div class="ttdoc">Number of data points added to this DataPacket.</div><div class="ttdef"><b>Definition</b> <a href="data-packet_8h_source.html#l00048">data-packet.h:48</a></div></div>
<div class="ttc" id="atimestamp_8h_html"><div class="ttname"><a href="timestamp_8h.html">timestamp.h</a></div><div class="ttdoc">Management of timestamping and NTP synchronization.</div></div>
</div><!-- fragment --></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>