<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qirproximitysensor.cpp -->
<title>QIRProximityReading Class | Qt Sensors 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtsensors-index.html">Qt Sensors</a></td><td ><a href="qtsensors-module.html">C++ Classes</a></td><td >QIRProximityReading</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#qirproximityreading-units">QIRProximityReading Units</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QIRProximityReading Class</h1>
<!-- $$$QIRProximityReading-brief -->
<p>The <a href="qirproximityreading.html">QIRProximityReading</a> class holds readings from the IR proximity sensor. <a href="#details">More...</a></p>
<!-- @@@QIRProximityReading -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QIRProximityReading></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += sensors</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qsensorreading.html">QSensorReading</a></td></tr></table></div><ul>
<li><a href="qirproximityreading-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qirproximityreading.html#reflectance-prop">reflectance</a></b> : const qreal</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qsensorreading.html#properties">QSensorReading</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qirproximityreading.html#reflectance-prop">reflectance</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qirproximityreading.html#setReflectance">setReflectance</a></b>(qreal <i>reflectance</i>)</td></tr>
</table></div>
<ul>
<li class="fn">4 public functions inherited from <a href="qsensorreading.html#public-functions">QSensorReading</a></li>
</ul>
<a name="details"></a>
<!-- $$$QIRProximityReading-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qirproximityreading.html">QIRProximityReading</a> class holds readings from the IR proximity sensor.</p>
<p>The IR (infra-red) proximity sensor detects proximity by beaming out infra-red light and detecting how much of the light returns.</p>
<p>The biggest limitation of this technology is that there is no reliable way to turn the reflectance values into distances unless both the item being detected and the ambient conditions are known.</p>
<a name="qirproximityreading-units"></a>
<h4 >QIRProximityReading Units</h4>
<p>The sensor reports reflectance as a decimal fraction in the range of 0 - 1. That is, 0 indicates nothing was detected within the range of the sensor and 1 indicates the infra-red signal returned at the full power level that it was sent at.</p>
<p>With some IR sensors, it is quite uncommon to reach the top and the bottom of the value range, and some parts of the range ends might not be obtainable at all. This is due to the behavior of the sensor hardware. With these sensors, the absolute value of reflectance should never be used directly. Instead, applications should react to the relative change of the reading values. Use <a href="qproximitysensor.html">QProximitySensor</a> if it is only necessary to check if something is close to the device or not.</p>
</div>
<!-- @@@QIRProximityReading -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$reflectance-prop$$$reflectance -->
<h3 class="fn" id="reflectance-prop"><a name="reflectance-prop"></a><span class="name">reflectance</span> : const <span class="type">qreal</span></h3>
<p>Holds the reflectance value.</p>
<p>The reflectance is a decimal fraction (from 0 to 1) indicating how much of the transmitted infra-red light was returned.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>reflectance</b></span>() const</td></tr>
</table></div>
<p><b>See also </b><a href="qirproximityreading.html#qirproximityreading-units">QIRProximityReading Units</a>.</p>
<!-- @@@reflectance -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$setReflectance[overload1]$$$setReflectanceqreal -->
<h3 class="fn" id="setReflectance"><a name="setReflectance"></a><span class="type">void</span> QIRProximityReading::<span class="name">setReflectance</span>(<span class="type">qreal</span> <i>reflectance</i>)</h3>
<p>Sets the reflectance value to <i>reflectance</i>.</p>
<p><b>See also </b><a href="qirproximityreading.html#reflectance-prop">reflectance</a>().</p>
<!-- @@@setReflectance -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
aa084d0e0126d94ee0fb846ebdf50e37
>
files
>
109
