1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
|
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: sensors::NumericSensor_4_0_3::MetaData 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesensors.html">sensors</a></li><li class="navelem"><a class="el" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a></li><li class="navelem"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html">MetaData</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sensors::NumericSensor_4_0_3::MetaData Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Numeric sensor metadata.
<a href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#details">More...</a></p>
<p><code>import"<a class="el" href="NumericSensor_8idl_source.html">NumericSensor.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a75f4337b18e19bc334d98ef10b8afb57"><td class="memItemLeft" align="right" valign="top"><a id="a75f4337b18e19bc334d98ef10b8afb57"></a>
<a class="el" href="structsensors_1_1Sensor__4__0__3_1_1TypeSpec.html">Sensor_4_0_3::TypeSpec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a75f4337b18e19bc334d98ef10b8afb57">type</a></td></tr>
<tr class="memdesc:a75f4337b18e19bc334d98ef10b8afb57"><td class="mdescLeft"> </td><td class="mdescRight">Sensor type, reading type and unit. <br /></td></tr>
<tr class="separator:a75f4337b18e19bc334d98ef10b8afb57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f9fa9c2e43d875964af60b4ace7e725"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a4f9fa9c2e43d875964af60b4ace7e725">decdigits</a></td></tr>
<tr class="memdesc:a4f9fa9c2e43d875964af60b4ace7e725"><td class="mdescLeft"> </td><td class="mdescRight">Number of significant decimal digits. <a href="#a4f9fa9c2e43d875964af60b4ace7e725">More...</a><br /></td></tr>
<tr class="separator:a4f9fa9c2e43d875964af60b4ace7e725"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cca4f6479283171c8d7226039c09964"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a2cca4f6479283171c8d7226039c09964">accuracy</a></td></tr>
<tr class="memdesc:a2cca4f6479283171c8d7226039c09964"><td class="mdescLeft"> </td><td class="mdescRight">Sensor accuracy in percent. <a href="#a2cca4f6479283171c8d7226039c09964">More...</a><br /></td></tr>
<tr class="separator:a2cca4f6479283171c8d7226039c09964"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad38ed8a3721de1b5022703f8f25c3b30"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#ad38ed8a3721de1b5022703f8f25c3b30">resolution</a></td></tr>
<tr class="memdesc:ad38ed8a3721de1b5022703f8f25c3b30"><td class="mdescLeft"> </td><td class="mdescRight">Sensor resolution. <a href="#ad38ed8a3721de1b5022703f8f25c3b30">More...</a><br /></td></tr>
<tr class="separator:ad38ed8a3721de1b5022703f8f25c3b30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7087532095ec850c5df481172510a1af"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a7087532095ec850c5df481172510a1af">tolerance</a></td></tr>
<tr class="memdesc:a7087532095ec850c5df481172510a1af"><td class="mdescLeft"> </td><td class="mdescRight">Sensor tolerance. <a href="#a7087532095ec850c5df481172510a1af">More...</a><br /></td></tr>
<tr class="separator:a7087532095ec850c5df481172510a1af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ded4888e79b3484d05e866183df73e0"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a7ded4888e79b3484d05e866183df73e0">noiseThreshold</a></td></tr>
<tr class="memdesc:a7ded4888e79b3484d05e866183df73e0"><td class="mdescLeft"> </td><td class="mdescRight">Sensor noise threshold. <a href="#a7ded4888e79b3484d05e866183df73e0">More...</a><br /></td></tr>
<tr class="separator:a7ded4888e79b3484d05e866183df73e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7420a943f544f8e569935ae50a62b846"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1Range.html">Range</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a7420a943f544f8e569935ae50a62b846">range</a></td></tr>
<tr class="memdesc:a7420a943f544f8e569935ae50a62b846"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1Range.html" title="Range of possible sensor readings. ">Range</a> of possible sensor readings. <a href="#a7420a943f544f8e569935ae50a62b846">More...</a><br /></td></tr>
<tr class="separator:a7420a943f544f8e569935ae50a62b846"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93c6d847bce68790ab3582c44f60b38e"><td class="memItemLeft" align="right" valign="top"><a id="a93c6d847bce68790ab3582c44f60b38e"></a>
<a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1ThresholdCapabilities.html">ThresholdCapabilities</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1MetaData.html#a93c6d847bce68790ab3582c44f60b38e">thresholdCaps</a></td></tr>
<tr class="memdesc:a93c6d847bce68790ab3582c44f60b38e"><td class="mdescLeft"> </td><td class="mdescRight">Threshold capabilities. <br /></td></tr>
<tr class="separator:a93c6d847bce68790ab3582c44f60b38e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Numeric sensor metadata. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a2cca4f6479283171c8d7226039c09964"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cca4f6479283171c8d7226039c09964">◆ </a></span>accuracy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float sensors::NumericSensor_4_0_3::MetaData::accuracy</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor accuracy in percent. </p>
<p>How close in percent measurement is to actual value. This value has an implicit precision of 2, i.e. the double value must be rounded for 2 decimal digits before use. For example a reading of 10.0 and an accuracy of 0.2 means the actual reading value is 10.0 +/- 0.2%.</p>
<p>A value of 0 means unused. </p>
</div>
</div>
<a id="a4f9fa9c2e43d875964af60b4ace7e725"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f9fa9c2e43d875964af60b4ace7e725">◆ </a></span>decdigits</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sensors::NumericSensor_4_0_3::MetaData::decdigits</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of significant decimal digits. </p>
<p>Indicates how many digits should be displayed to the right of the decimal point. I.e. double values must be rounded with this precision. </p>
</div>
</div>
<a id="a7ded4888e79b3484d05e866183df73e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ded4888e79b3484d05e866183df73e0">◆ </a></span>noiseThreshold</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float sensors::NumericSensor_4_0_3::MetaData::noiseThreshold</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor noise threshold. </p>
<p>Threshold under which sensor measurements will be ignored. Sensor measurements below that value will be reported at the lower bound of the sensor range. </p>
</div>
</div>
<a id="a7420a943f544f8e569935ae50a62b846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7420a943f544f8e569935ae50a62b846">◆ </a></span>range</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1Range.html">Range</a> sensors::NumericSensor_4_0_3::MetaData::range</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1Range.html" title="Range of possible sensor readings. ">Range</a> of possible sensor readings. </p>
<p><a class="el" href="structsensors_1_1NumericSensor__4__0__3_1_1Range.html" title="Range of possible sensor readings. ">Range</a> values are rounded with with decimal digits. </p>
</div>
</div>
<a id="ad38ed8a3721de1b5022703f8f25c3b30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad38ed8a3721de1b5022703f8f25c3b30">◆ </a></span>resolution</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float sensors::NumericSensor_4_0_3::MetaData::resolution</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor resolution. </p>
<p>Minimum difference between any two measured values. Must be rounded with decimal digits. </p>
</div>
</div>
<a id="a7087532095ec850c5df481172510a1af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7087532095ec850c5df481172510a1af">◆ </a></span>tolerance</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float sensors::NumericSensor_4_0_3::MetaData::tolerance</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor tolerance. </p>
<p>Tolerance is given in +/- counts of the reading value. It indicates a constant magnitude possible error in the quantization of an analog input to the sensor. Rounded with decimal digits + 1.</p>
<p>A value of 0 means unused. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="NumericSensor_8idl_source.html">NumericSensor.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|