Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > aa084d0e0126d94ee0fb846ebdf50e37 > files > 241

qtsensors5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsensorbackend.cpp -->
  <title>QSensorBackend 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 >QSensorBackend</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QSensorBackend Class</h1>
<!-- $$$QSensorBackend-brief -->
<p>The <a href="qsensorbackend.html">QSensorBackend</a> class is a sensor implementation. <a href="#details">More...</a></p>
<!-- @@@QSensorBackend -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QSensorBackend&gt;</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></table></div><ul>
<li><a href="qsensorbackend-members.html">List of all members, including inherited members</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"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#addDataRate">addDataRate</a></b>(qreal <i>min</i>, qreal <i>max</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#addOutputRange">addOutputRange</a></b>(qreal <i>min</i>, qreal <i>max</i>, qreal <i>accuracy</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#isFeatureSupported">isFeatureSupported</a></b>(QSensor::Feature <i>feature</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#newReadingAvailable">newReadingAvailable</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSensorReading *</td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#reading">reading</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSensor *</td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#sensor">sensor</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#sensorBusy">sensorBusy</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#sensorError">sensorError</a></b>(int <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#sensorStopped">sensorStopped</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#setDataRates">setDataRates</a></b>(const QSensor *<i>otherSensor</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#setDescription">setDescription</a></b>(const QString &amp;<i>description</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> T *</td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#setReading">setReading</a></b>(T *<i>reading</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#start">start</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsensorbackend.html#stop">stop</a></b>() = 0</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QSensorBackend-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qsensorbackend.html">QSensorBackend</a> class is a sensor implementation.</p>
<p>Sensors on a device will be represented by sub-classes of <a href="qsensorbackend.html">QSensorBackend</a>.</p>
</div>
<!-- @@@QSensorBackend -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$addDataRate[overload1]$$$addDataRateqrealqreal -->
<h3 class="fn" id="addDataRate"><a name="addDataRate"></a><span class="type">void</span> QSensorBackend::<span class="name">addDataRate</span>(<span class="type">qreal</span> <i>min</i>, <span class="type">qreal</span> <i>max</i>)</h3>
<p>Add a data rate (consisting of <i>min</i> and <i>max</i> values) for the sensor.</p>
<p>Note that this function should be called from the constructor so that the information is available immediately.</p>
<p><b>See also </b><a href="qsensor.html#availableDataRates-prop">QSensor::availableDataRates</a>.</p>
<!-- @@@addDataRate -->
<!-- $$$addOutputRange[overload1]$$$addOutputRangeqrealqrealqreal -->
<h3 class="fn" id="addOutputRange"><a name="addOutputRange"></a><span class="type">void</span> QSensorBackend::<span class="name">addOutputRange</span>(<span class="type">qreal</span> <i>min</i>, <span class="type">qreal</span> <i>max</i>, <span class="type">qreal</span> <i>accuracy</i>)</h3>
<p>Add an output range (consisting of <i>min</i>, <i>max</i> values and <i>accuracy</i>) for the sensor.</p>
<p>Note that this function should be called from the constructor so that the information is available immediately.</p>
<p><b>See also </b><a href="qsensor.html#outputRange-prop">QSensor::outputRange</a> and <a href="qsensor.html#outputRanges-prop">QSensor::outputRanges</a>.</p>
<!-- @@@addOutputRange -->
<!-- $$$isFeatureSupported[overload1]$$$isFeatureSupportedQSensor::Feature -->
<h3 class="fn" id="isFeatureSupported"><a name="isFeatureSupported"></a><code>[virtual] </code><span class="type">bool</span> QSensorBackend::<span class="name">isFeatureSupported</span>(<span class="type"><a href="qsensor.html#Feature-enum">QSensor::Feature</a></span> <i>feature</i>) const</h3>
<p>Checks whether a feature is supported by this sensor backend.</p>
<p>This is the backend side of <a href="qsensor.html#isFeatureSupported">QSensor::isFeatureSupported</a>(). Reimplement this function if the backend supports one of the additional sensor features of <a href="qsensor.html#Feature-enum">QSensor::Feature</a>.</p>
<p>Returns whether the feature <i>feature</i> is supported by this backend. The default implementation returns false.</p>
<p>This function was introduced in  Qt 5.0.</p>
<!-- @@@isFeatureSupported -->
<!-- $$$newReadingAvailable[overload1]$$$newReadingAvailable -->
<h3 class="fn" id="newReadingAvailable"><a name="newReadingAvailable"></a><span class="type">void</span> QSensorBackend::<span class="name">newReadingAvailable</span>()</h3>
<p>Notify the <a href="qsensor.html">QSensor</a> class that a new reading is available.</p>
<!-- @@@newReadingAvailable -->
<!-- $$$reading[overload1]$$$reading -->
<h3 class="fn" id="reading"><a name="reading"></a><span class="type"><a href="qsensorreading.html">QSensorReading</a></span> *QSensorBackend::<span class="name">reading</span>() const</h3>
<p>If the backend has lost its reference to the reading it can call this method to get the address.</p>
<p>Note that you will need to down-cast to the appropriate type.</p>
<p><b>See also </b><a href="qsensorbackend.html#setReading">setReading</a>().</p>
<!-- @@@reading -->
<!-- $$$sensor[overload1]$$$sensor -->
<h3 class="fn" id="sensor"><a name="sensor"></a><span class="type"><a href="qsensor.html">QSensor</a></span> *QSensorBackend::<span class="name">sensor</span>() const</h3>
<p>Returns the sensor front end associated with this backend.</p>
<!-- @@@sensor -->
<!-- $$$sensorBusy[overload1]$$$sensorBusy -->
<h3 class="fn" id="sensorBusy"><a name="sensorBusy"></a><span class="type">void</span> QSensorBackend::<span class="name">sensorBusy</span>()</h3>
<p>Inform the front end that the sensor is busy. This implicitly calls <a href="qsensorbackend.html#sensorStopped">sensorStopped</a>() and is typically called from <a href="qsensorbackend.html#start">start</a>().</p>
<p>Note that the front end must call <a href="qsensor.html#busy-prop">QSensor::isBusy</a>() to see if the sensor is busy. If the sensor has stopped due to an error the <a href="qsensorbackend.html#sensorError">sensorError</a>() function should be called to notify the class of the error condition.</p>
<!-- @@@sensorBusy -->
<!-- $$$sensorError[overload1]$$$sensorErrorint -->
<h3 class="fn" id="sensorError"><a name="sensorError"></a><span class="type">void</span> QSensorBackend::<span class="name">sensorError</span>(<span class="type">int</span> <i>error</i>)</h3>
<p>Inform the front end that a sensor error occurred. Note that this only reports an <i>error</i> code. It does not stop the sensor.</p>
<p><b>See also </b><a href="qsensorbackend.html#sensorStopped">sensorStopped</a>().</p>
<!-- @@@sensorError -->
<!-- $$$sensorStopped[overload1]$$$sensorStopped -->
<h3 class="fn" id="sensorStopped"><a name="sensorStopped"></a><span class="type">void</span> QSensorBackend::<span class="name">sensorStopped</span>()</h3>
<p>Inform the front end that the sensor has stopped. This can be due to <a href="qsensorbackend.html#start">start</a>() failing or for some unexpected reason (eg. hardware failure).</p>
<p>Note that the front end must call <a href="qsensor.html#active-prop">QSensor::isActive</a>() to see if the sensor has stopped. If the sensor has stopped due to an error the <a href="qsensorbackend.html#sensorError">sensorError</a>() function should be called to notify the class of the error condition.</p>
<!-- @@@sensorStopped -->
<!-- $$$setDataRates[overload1]$$$setDataRatesconstQSensor* -->
<h3 class="fn" id="setDataRates"><a name="setDataRates"></a><span class="type">void</span> QSensorBackend::<span class="name">setDataRates</span>(const <span class="type"><a href="qsensor.html">QSensor</a></span> *<i>otherSensor</i>)</h3>
<p>Set the data rates for the sensor based on <i>otherSensor</i>.</p>
<p>This is designed for sensors that are based on other sensors.</p>
<pre class="cpp">

  setDataRates(otherSensor);

</pre>
<p>Note that this function must be called from the constructor.</p>
<p><b>See also </b><a href="qsensor.html#availableDataRates-prop">QSensor::availableDataRates</a> and <a href="qsensorbackend.html#addDataRate">addDataRate</a>().</p>
<!-- @@@setDataRates -->
<!-- $$$setDescription[overload1]$$$setDescriptionconstQString& -->
<h3 class="fn" id="setDescription"><a name="setDescription"></a><span class="type">void</span> QSensorBackend::<span class="name">setDescription</span>(const <span class="type">QString</span> &amp;<i>description</i>)</h3>
<p>Set the <i>description</i> for the sensor.</p>
<p>Note that this function should be called from the constructor so that the information is available immediately.</p>
<!-- @@@setDescription -->
<!-- $$$setReading[overload1]$$$setReadingT* -->
<h3 class="fn" id="setReading"><a name="setReading"></a><span class="type">T</span> *QSensorBackend::<span class="name">setReading</span>(<span class="type">T</span> *<i>reading</i>)</h3>
<p>This function is called to initialize the <i>reading</i> classes used for a sensor.</p>
<p>If your backend has already allocated a reading you should pass the address of this to the function. Otherwise you should pass 0 and the function will return the address of the reading your backend should use when it wants to notify the sensor API of new readings.</p>
<p>Note that this is a template function so it should be called with the appropriate type.</p>
<pre class="cpp">

  <span class="keyword">class</span> MyBackend : <span class="keyword">public</span> <span class="type">QSensorBackend</span>
  {
      <span class="type"><a href="qaccelerometerreading.html">QAccelerometerReading</a></span> m_reading;
  <span class="keyword">public</span>:
      MyBackend(<span class="type"><a href="qsensor.html">QSensor</a></span> <span class="operator">*</span>sensor)
          : <span class="type">QSensorBackend</span>(sensor)
      {
          setReading<span class="operator">&lt;</span><span class="type"><a href="qaccelerometerreading.html">QAccelerometerReading</a></span><span class="operator">&gt;</span>(<span class="operator">&amp;</span>m_reading);
      }

      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

</pre>
<p>Note that this function must be called or you will not be able to send readings to the front end.</p>
<p>If you do not wish to store the address of the reading you may use the <a href="qsensorbackend.html#reading">reading</a>() method to get it again later.</p>
<pre class="cpp">

  <span class="keyword">class</span> MyBackend : <span class="keyword">public</span> <span class="type">QSensorBackend</span>
  {
  <span class="keyword">public</span>:
      MyBackend(<span class="type"><a href="qsensor.html">QSensor</a></span> <span class="operator">*</span>sensor)
          : <span class="type">QSensorBackend</span>(sensor)
      {
          setReading<span class="operator">&lt;</span><span class="type"><a href="qaccelerometerreading.html">QAccelerometerReading</a></span><span class="operator">&gt;</span>(<span class="number">0</span>);
      }

      <span class="type">void</span> poll()
      {
          <span class="type">quint64</span> timestamp;
          <span class="type">qreal</span> x<span class="operator">,</span> y<span class="operator">,</span> z;
          <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
          <span class="type"><a href="qaccelerometerreading.html">QAccelerometerReading</a></span> <span class="operator">*</span>reading <span class="operator">=</span> <span class="keyword">static_cast</span><span class="operator">&lt;</span><span class="type"><a href="qaccelerometerreading.html">QAccelerometerReading</a></span><span class="operator">*</span><span class="operator">&gt;</span>(reading());
          reading<span class="operator">-</span><span class="operator">&gt;</span>setTimestamp(timestamp);
          reading<span class="operator">-</span><span class="operator">&gt;</span>setX(x);
          reading<span class="operator">-</span><span class="operator">&gt;</span>setY(y);
          reading<span class="operator">-</span><span class="operator">&gt;</span>setZ(z);
      }

      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>

</pre>
<p><b>See also </b><a href="qsensorbackend.html#reading">reading</a>().</p>
<!-- @@@setReading -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn" id="start"><a name="start"></a><code>[pure virtual] </code><span class="type">void</span> QSensorBackend::<span class="name">start</span>()</h3>
<p>Start reporting values.</p>
<!-- @@@start -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[pure virtual] </code><span class="type">void</span> QSensorBackend::<span class="name">stop</span>()</h3>
<p>Stop reporting values.</p>
<!-- @@@stop -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional