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 documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
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** GNU Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file. Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29    \example satelliteinfo
30    \title SatelliteInfo (C++/QML)
31
32    \brief The SatelliteInfo example shows how the available satellites
33    at the user's current position and marks the satellites
34    currently contributing to the GPS fix as pink.
35
36    \ingroup qtpositioning-examples
37
38    Key \l{Qt Positioning} classes used in this example:
39
40    \list
41    \li \l{QGeoSatelliteInfo}
42    \li \l{QGeoSatelliteInfoSource}
43    \endlist
44
45    \image ../images/example-satelliteinfo.png
46
47    The example displays the signal strength of all satellites in view. Any satellite
48    that is currently used to calculate the GPS fix has been marked pink. The number at
49    the bottom of each signal bar is the individual satellite identifier.
50
51    The application operates in three different modes:
52
53    \table
54        \header
55            \li Application mode
56            \li Description
57        \row
58            \li running
59            \li The application continuously queries the system for satellite updates. When new data
60                is available it will be displayed.
61        \row
62            \li stopped
63            \li The application stops updating the satellite information.
64        \row
65            \li single
66            \li The application makes a single update request with a timeout of 10s. The display
67                remains empty until the request was answered by the system.
68    \endtable
69
70    If the platform does not provide satellite information the application automatically
71    switches into a demo mode whereby it continuously switches between predefined
72    sets of satellite data.
73
74    \include examples-run.qdocinc
75*/
76