QGeoSatelliteInfoSource Class

 // Emit updates every 10 seconds if available
 QGeoSatelliteInfoSource *source = QGeoSatelliteInfoSource::createDefaultSource(0);
 if (source)
     source->setUpdateInterval(10000);

Member Function Documentation

[signal] void QGeoSatelliteInfoSource::errorOccurred(QGeoSatelliteInfoSource::Error satelliteError)

This signal is emitted after an error occurred. The satelliteError parameter describes the type of error that occurred.

[pure virtual slot] void QGeoSatelliteInfoSource::requestUpdate(int timeout = 0)

Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information. If the current satellite information cannot be found within the given timeout (in milliseconds) or if timeout is less than the value returned by minimumUpdateInterval(), an errorOccurred() signal with UpdateTimeoutError is emitted.

If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.

This does nothing if another update request is in progress. However it can be called even if startUpdates() has already been called and regular updates are in progress.

Note: Since Qt6 this method always resets the last error to NoError before requesting the satellite information.

Note: To understand how to use this method from an Android service, see Qt Positioning on Android.

[signal] void QGeoSatelliteInfoSource::satellitesInUseUpdated(const QList<QGeoSatelliteInfo> &satellites)

If startUpdates() or requestUpdate() is called, this signal is emitted when an update is available on the number of satellites that are currently in use.

These are the satellites that are used to get a "fix" - that is, those used to determine the current position.

The satellites parameter holds the satellites currently in use.

[signal] void QGeoSatelliteInfoSource::satellitesInViewUpdated(const QList<QGeoSatelliteInfo> &satellites)

If startUpdates() or requestUpdate() is called, this signal is emitted when an update is available on the satellites that are currently in view.

The satellites parameter holds the satellites currently in view.

[pure virtual slot] void QGeoSatelliteInfoSource::startUpdates()

Starts emitting updates at regular intervals. The updates will be provided whenever new satellite information becomes available.

If satellite information cannot be retrieved or some other form of timeout has occurred the satellitesInViewUpdated() and satellitesInUseUpdated() signals may be emitted with empty parameter lists.

Note: Since Qt6 this method always resets the last error to NoError before starting the updates.

Note: To understand how to use this method from an Android service, see Qt Positioning on Android.

See also satellitesInViewUpdated() and satellitesInUseUpdated().

[pure virtual slot] void QGeoSatelliteInfoSource::stopUpdates()

Stops emitting updates at regular intervals.

[virtual] QGeoSatelliteInfoSource::~QGeoSatelliteInfoSource()

Destroys the satellite source.

[static] QStringList QGeoSatelliteInfoSource::availableSources()

Returns a list of available source plugins, including the default system backend if one is available.

[virtual, since 6.2] QVariant QGeoSatelliteInfoSource::backendProperty(const QString &name) const

Returns the value of the backend-specific property named name, if present. Otherwise the returned value will be invalid.

This function was introduced in Qt 6.2.

See also setBackendProperty.

[static] QGeoSatelliteInfoSource *QGeoSatelliteInfoSource::createDefaultSource(QObject *parent)

Creates and returns a source with the specified parent that reads from the system's default source of satellite update information, or the highest priority available plugin.

Returns nullptr if the system has no default satellite source, no valid plugins could be found or the user does not have the permission to access the satellite data.

[static, since Qt 5.14] QGeoSatelliteInfoSource *QGeoSatelliteInfoSource::createDefaultSource(const QVariantMap &parameters, QObject *parent)

Creates and returns a satellite source with the given parent that reads from the system's default sources of satellite data, or the plugin with the highest available priority.

Returns nullptr if the system has no default satellite source, no valid plugins could be found or the user does not have the permission to access the satellite information.

This method passes parameters to the factory to configure the source.

This function was introduced in Qt 5.14.

[static] QGeoSatelliteInfoSource *QGeoSatelliteInfoSource::createSource(const QString &sourceName, QObject *parent)

Creates and returns a source with the given parent, by loading the plugin named sourceName.

Returns nullptr if the plugin cannot be found.

[static, since Qt 5.14] QGeoSatelliteInfoSource *QGeoSatelliteInfoSource::createSource(const QString &sourceName, const QVariantMap &parameters, QObject *parent)

Creates and returns a satellite source with the given parent, by loading the plugin named sourceName.

Returns nullptr if the plugin cannot be found.

This method passes parameters to the factory to configure the source.

This function was introduced in Qt 5.14.

[pure virtual] QGeoSatelliteInfoSource::Error QGeoSatelliteInfoSource::error() const

Returns the last error that occurred.

Note: Since Qt6 the last error is always reset when calling startUpdates() or requestUpdate().

[virtual, since 6.2] bool QGeoSatelliteInfoSource::setBackendProperty(const QString &name, const QVariant &value)

Sets the backend-specific property named name to value. Returns true on success, false otherwise. Backend-specific properties can be used to configure the satellite info subsystem behavior at runtime.

This function was introduced in Qt 6.2.

See also backendProperty.

QString QGeoSatelliteInfoSource::sourceName() const

Returns the unique name of the satellite source implementation in use.

This is the same name that can be passed to createSource() in order to create a new instance of a particular satellite source implementation.