Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
<!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: DataPacket Struct 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"> 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&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&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> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structDataPacket-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DataPacket Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Stores data points included in an uploaded "measurement".
<a href="structDataPacket.html#details">More...</a></p>
<p><code>#include <<a class="el" href="data-packet_8h_source.html">data-packet.h</a>></code></p>
<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:abbf7bd0fe4fe3a4b9b2c2ded6bca3808" id="r_abbf7bd0fe4fe3a4b9b2c2ded6bca3808"><td class="memItemLeft" align="right" valign="top"><a id="abbf7bd0fe4fe3a4b9b2c2ded6bca3808" name="abbf7bd0fe4fe3a4b9b2c2ded6bca3808"></a>
constexpr </td><td class="memItemRight" valign="bottom"><b>DataPacket</b> ()=default</td></tr>
<tr class="memdesc:abbf7bd0fe4fe3a4b9b2c2ded6bca3808"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="structDataPacket.html" title="Stores data points included in an uploaded "measurement".">DataPacket</a> with sane defaults and an invalid timestamp. <br /></td></tr>
<tr class="separator:abbf7bd0fe4fe3a4b9b2c2ded6bca3808"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a917ddce56b4fc02243dca0d993278355" id="r_a917ddce56b4fc02243dca0d993278355"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structDataPacket.html#a917ddce56b4fc02243dca0d993278355">add</a> (float sample) noexcept</td></tr>
<tr class="memdesc:a917ddce56b4fc02243dca0d993278355"><td class="mdescLeft"> </td><td class="mdescRight">Factors a sample into the packet's data points. <br /></td></tr>
<tr class="separator:a917ddce56b4fc02243dca0d993278355"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:adc361a3409ff9fe2898e8196bf80ddd5" id="r_adc361a3409ff9fe2898e8196bf80ddd5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structDataPacket.html#adc361a3409ff9fe2898e8196bf80ddd5">count</a> = 0</td></tr>
<tr class="memdesc:adc361a3409ff9fe2898e8196bf80ddd5"><td class="mdescLeft"> </td><td class="mdescRight">Number of data points added to this <a class="el" href="structDataPacket.html" title="Stores data points included in an uploaded "measurement".">DataPacket</a>. <br /></td></tr>
<tr class="separator:adc361a3409ff9fe2898e8196bf80ddd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cd7df92da2eea9abb845f87f98271cc" id="r_a8cd7df92da2eea9abb845f87f98271cc"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structDataPacket.html#a8cd7df92da2eea9abb845f87f98271cc">minimum</a> = 999.f</td></tr>
<tr class="memdesc:a8cd7df92da2eea9abb845f87f98271cc"><td class="mdescLeft"> </td><td class="mdescRight">Minimum decibel value within the aggregated points. <br /></td></tr>
<tr class="separator:a8cd7df92da2eea9abb845f87f98271cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a932840e12a30bfc175a87573bc7da29a" id="r_a932840e12a30bfc175a87573bc7da29a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structDataPacket.html#a932840e12a30bfc175a87573bc7da29a">maximum</a> = 0.f</td></tr>
<tr class="memdesc:a932840e12a30bfc175a87573bc7da29a"><td class="mdescLeft"> </td><td class="mdescRight">Maximum decibel value within the aggregated points. <br /></td></tr>
<tr class="separator:a932840e12a30bfc175a87573bc7da29a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a468b65a654fc379b4099ef948467c117" id="r_a468b65a654fc379b4099ef948467c117"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structDataPacket.html#a468b65a654fc379b4099ef948467c117">average</a> = 0.f</td></tr>
<tr class="memdesc:a468b65a654fc379b4099ef948467c117"><td class="mdescLeft"> </td><td class="mdescRight">Average decibel value of the aggregated points. <br /></td></tr>
<tr class="separator:a468b65a654fc379b4099ef948467c117"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4baf5b92cbefdd6e16365b7b525e890" id="r_aa4baf5b92cbefdd6e16365b7b525e890"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTimestamp.html">Timestamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structDataPacket.html#aa4baf5b92cbefdd6e16365b7b525e890">timestamp</a> = <a class="el" href="classTimestamp.html#a66f54270c50d2435a310c6a459e3b747">Timestamp::invalidTimestamp</a>()</td></tr>
<tr class="memdesc:aa4baf5b92cbefdd6e16365b7b525e890"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classTimestamp.html" title="Timestamping facility that uses NTP to provide accurate date and time.">Timestamp</a> to indicate the ending time point of this <a class="el" href="structDataPacket.html" title="Stores data points included in an uploaded "measurement".">DataPacket</a>'s aggregation. <br /></td></tr>
<tr class="separator:aa4baf5b92cbefdd6e16365b7b525e890"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Stores data points included in an uploaded "measurement". </p>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00029">29</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a917ddce56b4fc02243dca0d993278355" name="a917ddce56b4fc02243dca0d993278355"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a917ddce56b4fc02243dca0d993278355">◆ </a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DataPacket::add </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>sample</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Factors a sample into the packet's data points. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sample</td><td>The dB sample value to add. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00040">40</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a468b65a654fc379b4099ef948467c117" name="a468b65a654fc379b4099ef948467c117"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a468b65a654fc379b4099ef948467c117">◆ </a></span>average</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float DataPacket::average = 0.f</td>
</tr>
</table>
</div><div class="memdoc">
<p>Average decibel value of the aggregated points. </p>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00057">57</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div>
</div>
<a id="adc361a3409ff9fe2898e8196bf80ddd5" name="adc361a3409ff9fe2898e8196bf80ddd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc361a3409ff9fe2898e8196bf80ddd5">◆ </a></span>count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DataPacket::count = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of data points added to this <a class="el" href="structDataPacket.html" title="Stores data points included in an uploaded "measurement".">DataPacket</a>. </p>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00048">48</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div>
</div>
<a id="a932840e12a30bfc175a87573bc7da29a" name="a932840e12a30bfc175a87573bc7da29a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a932840e12a30bfc175a87573bc7da29a">◆ </a></span>maximum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float DataPacket::maximum = 0.f</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum decibel value within the aggregated points. </p>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00054">54</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div>
</div>
<a id="a8cd7df92da2eea9abb845f87f98271cc" name="a8cd7df92da2eea9abb845f87f98271cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cd7df92da2eea9abb845f87f98271cc">◆ </a></span>minimum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float DataPacket::minimum = 999.f</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum decibel value within the aggregated points. </p>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00051">51</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div>
</div>
<a id="aa4baf5b92cbefdd6e16365b7b525e890" name="aa4baf5b92cbefdd6e16365b7b525e890"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4baf5b92cbefdd6e16365b7b525e890">◆ </a></span>timestamp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTimestamp.html">Timestamp</a> DataPacket::timestamp = <a class="el" href="classTimestamp.html#a66f54270c50d2435a310c6a459e3b747">Timestamp::invalidTimestamp</a>()</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classTimestamp.html" title="Timestamping facility that uses NTP to provide accurate date and time.">Timestamp</a> to indicate the ending time point of this <a class="el" href="structDataPacket.html" title="Stores data points included in an uploaded "measurement".">DataPacket</a>'s aggregation. </p>
<p>This should be manually set before the <a class="el" href="structDataPacket.html" title="Stores data points included in an uploaded "measurement".">DataPacket</a> is uploaded to the server. </p>
<p class="definition">Definition at line <a class="el" href="data-packet_8h_source.html#l00064">64</a> of file <a class="el" href="data-packet_8h_source.html">data-packet.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>noisemeter-device/<a class="el" href="data-packet_8h_source.html">data-packet.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <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>
01e1f04e3This file is pinned to the selected release. Download the original to open it in your design tool.