Sophie

Sophie

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

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" />
  <title>gruesensor.cpp Example File | 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-grue-example.html">Qt Sensors - Grue Sensor Example</a></td><td >gruesensor.cpp Example File</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="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">gruesensor.cpp Example File</h1>
<span class="subtitle">grue/lib/gruesensor.cpp</span>
<!-- $$$grue/lib/gruesensor.cpp-description -->
<div class="descr"> <a name="details"></a>
<pre class="cpp">

  <span class="comment">/****************************************************************************
  **
  ** Copyright (C) 2017 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the QtSensors module of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:BSD$
  ** Commercial License Usage
  ** Licensees holding valid commercial Qt licenses may use this file in
  ** accordance with the commercial license agreement provided with the
  ** Software or, alternatively, in accordance with the terms contained in
  ** a written agreement between you and The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** BSD License Usage
  ** Alternatively, you may use this file under the terms of the BSD license
  ** as follows:
  **
  ** &quot;Redistribution and use in source and binary forms, with or without
  ** modification, are permitted provided that the following conditions are
  ** met:
  **   * Redistributions of source code must retain the above copyright
  **     notice, this list of conditions and the following disclaimer.
  **   * Redistributions in binary form must reproduce the above copyright
  **     notice, this list of conditions and the following disclaimer in
  **     the documentation and/or other materials provided with the
  **     distribution.
  **   * Neither the name of The Qt Company Ltd nor the names of its
  **     contributors may be used to endorse or promote products derived
  **     from this software without specific prior written permission.
  **
  **
  ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  ** &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.&quot;
  **
  ** $QT_END_LICENSE$
  **
  ****************************************************************************/</span>

  <span class="preprocessor">#include &quot;gruesensor.h&quot;</span>
  <span class="preprocessor">#include &quot;gruesensor_p.h&quot;</span>

  IMPLEMENT_READING(GrueSensorReading)

  <span class="comment">/*
      \omit
      \class GrueSensorReading

      \brief The GrueSensorReading class holds readings from the Grue sensor.

      The Grue Sensor informs you of your chance of being eaten by a Grue.

      Grues love the dark so as long as your surroundings are relatively light
      you are safe. However the more time you spend in the dark, the higher
      your chances are of being eaten by a Grue.
  */</span>

  <span class="comment">/*
      \property GrueSensorReading::chanceOfBeingEaten
      \brief holds your chance of being eaten.

      The value is the probability (from 0 to 100) that a Grue will eat you.
      A probability of 100 means you are currently being eaten. The darker
      it is, the more likely you are to be eaten by a Grue. The longer you
      stay in a dark area, the more likely you are to be eaten by a Grue.
      If you are in a lit room, the probability will be 0 as Grues fear light.
      \endomit
  */</span>

  <span class="type">int</span> GrueSensorReading<span class="operator">::</span>chanceOfBeingEaten() <span class="keyword">const</span>
  {
      <span class="keyword">return</span> d<span class="operator">-</span><span class="operator">&gt;</span>chanceOfBeingEaten;
  }

  <span class="type">void</span> GrueSensorReading<span class="operator">::</span>setChanceOfBeingEaten(<span class="type">int</span> chanceOfBeingEaten)
  {
      d<span class="operator">-</span><span class="operator">&gt;</span>chanceOfBeingEaten <span class="operator">=</span> chanceOfBeingEaten;
  }

  <span class="comment">// =====================================================================</span>

  <span class="comment">// begin generated code</span>

  <span class="comment">/*
      \omit
      \class GrueFilter

      \brief The GrueFilter class is a convenience wrapper around QSensorFilter.

      The only difference is that the filter() method features a pointer to GrueSensorReading
      instead of QSensorReading.
      \endomit
  */</span>

  <span class="comment">/*
      \omit
      \fn GrueFilter::filter(GrueSensorReading *reading)

      Called when \a reading changes. Returns false to prevent the reading from propagating.

      \sa QSensorFilter::filter()
      \endomit
  */</span>

  <span class="type">char</span> <span class="keyword">const</span> <span class="operator">*</span> <span class="keyword">const</span> GrueSensor<span class="operator">::</span>type(<span class="string">&quot;GrueSensor&quot;</span>);

  <span class="comment">/*
      \omit
      \class GrueSensor

      \brief The GrueSensor class is a convenience wrapper around QSensor.

      The only behavioural difference is that this class sets the type properly.

      This class also features a reading() function that returns a GrueSensorReading instead of a QSensorReading.

      For details about how the sensor works, see \l GrueSensorReading.

      \sa GrueSensorReading
      \endomit
  */</span>

  <span class="comment">/*
      \omit
      \fn GrueSensor::GrueSensor(QObject *parent)

      Construct the sensor as a child of \a parent.
      \endomit
  */</span>

  <span class="comment">/*
      \fn GrueSensor::~GrueSensor()

      Destroy the sensor. Stops the sensor if it has not already been stopped.
  */</span>

  <span class="comment">/*
      \omit
      \fn GrueSensor::reading() const

      Returns the reading class for this sensor.

      \sa QSensor::reading()
      \endomit
  */</span>
  <span class="comment">// end generated code</span>

  <span class="preprocessor">#include &quot;moc_gruesensor.cpp&quot;</span>

</pre>
</div>
<!-- @@@grue/lib/gruesensor.cpp -->
        </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>