/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example satelliteinfo
    \title SatelliteInfo (C++/QML)

    \brief The SatelliteInfo example shows how the available satellites
    at the user's current position and marks the satellites
    currently contributing to the GPS fix as pink.

    \ingroup qtpositioning-examples

    Key \l{Qt Positioning} classes used in this example:

    \list
    \li \l{QGeoSatelliteInfo}
    \li \l{QGeoSatelliteInfoSource}
    \endlist

    \image ../images/example-satelliteinfo.png

    The example displays the signal strength of all satellites in view. Any satellite
    that is currently used to calculate the GPS fix has been marked pink. The number at
    the bottom of each signal bar is the individual satellite identifier.

    The application operates in three different modes:

    \table
        \header
            \li Application mode
            \li Description
        \row
            \li running
            \li The application continuously queries the system for satellite updates. When new data
                is available it will be displayed.
        \row
            \li stopped
            \li The application stops updating the satellite information.
        \row
            \li single
            \li The application makes a single update request with a timeout of 10s. The display
                remains empty until the request was answered by the system.
    \endtable

    If the platform does not provide satellite information the application automatically
    switches into a demo mode whereby it continuously switches between predefined
    sets of satellite data.

    \include examples-run.qdocinc
*/