1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtSensors module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:BSD$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** BSD License Usage
18** Alternatively, you may use this file under the terms of the BSD license
19** as follows:
20**
21** "Redistribution and use in source and binary forms, with or without
22** modification, are permitted provided that the following conditions are
23** met:
24** * Redistributions of source code must retain the above copyright
25** notice, this list of conditions and the following disclaimer.
26** * Redistributions in binary form must reproduce the above copyright
27** notice, this list of conditions and the following disclaimer in
28** the documentation and/or other materials provided with the
29** distribution.
30** * Neither the name of The Qt Company Ltd nor the names of its
31** contributors may be used to endorse or promote products derived
32** from this software without specific prior written permission.
33**
34**
35** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
46**
47** $QT_END_LICENSE$
48**
49****************************************************************************/
50
51#include "gruesensor.h"
52#include "gruesensor_p.h"
53
54IMPLEMENT_READING(GrueSensorReading)
55
56/*
57 \omit
58 \class GrueSensorReading
59
60 \brief The GrueSensorReading class holds readings from the Grue sensor.
61
62 The Grue Sensor informs you of your chance of being eaten by a Grue.
63
64 Grues love the dark so as long as your surroundings are relatively light
65 you are safe. However the more time you spend in the dark, the higher
66 your chances are of being eaten by a Grue.
67*/
68
69/*
70 \property GrueSensorReading::chanceOfBeingEaten
71 \brief holds your chance of being eaten.
72
73 The value is the probability (from 0 to 100) that a Grue will eat you.
74 A probability of 100 means you are currently being eaten. The darker
75 it is, the more likely you are to be eaten by a Grue. The longer you
76 stay in a dark area, the more likely you are to be eaten by a Grue.
77 If you are in a lit room, the probability will be 0 as Grues fear light.
78 \endomit
79*/
80
81int GrueSensorReading::chanceOfBeingEaten() const
82{
83 return d->chanceOfBeingEaten;
84}
85
86void GrueSensorReading::setChanceOfBeingEaten(int chanceOfBeingEaten)
87{
88 d->chanceOfBeingEaten = chanceOfBeingEaten;
89}
90
91// =====================================================================
92
93// begin generated code
94
95/*
96 \omit
97 \class GrueFilter
98
99 \brief The GrueFilter class is a convenience wrapper around QSensorFilter.
100
101 The only difference is that the filter() method features a pointer to GrueSensorReading
102 instead of QSensorReading.
103 \endomit
104*/
105
106/*
107 \omit
108 \fn GrueFilter::filter(GrueSensorReading *reading)
109
110 Called when \a reading changes. Returns false to prevent the reading from propagating.
111
112 \sa QSensorFilter::filter()
113 \endomit
114*/
115
116char const * const GrueSensor::type("GrueSensor");
117
118/*
119 \omit
120 \class GrueSensor
121
122 \brief The GrueSensor class is a convenience wrapper around QSensor.
123
124 The only behavioural difference is that this class sets the type properly.
125
126 This class also features a reading() function that returns a GrueSensorReading instead of a QSensorReading.
127
128 For details about how the sensor works, see \l GrueSensorReading.
129
130 \sa GrueSensorReading
131 \endomit
132*/
133
134/*
135 \omit
136 \fn GrueSensor::GrueSensor(QObject *parent)
137
138 Construct the sensor as a child of \a parent.
139 \endomit
140*/
141
142/*
143 \fn GrueSensor::~GrueSensor()
144
145 Destroy the sensor. Stops the sensor if it has not already been stopped.
146*/
147
148/*
149 \omit
150 \fn GrueSensor::reading() const
151
152 Returns the reading class for this sensor.
153
154 \sa QSensor::reading()
155 \endomit
156*/
157// end generated code
158
159#include "moc_gruesensor.cpp"
160

source code of qtsensors/examples/sensors/grue/lib/gruesensor.cpp