QGeoSatelliteInfoSource Class | Qt Positioning | Qt 6.11.1
Description: The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates.

- Qt 6.11
- Qt Positioning
- C++ Classes
- QGeoSatelliteInfoSource
- Qt 6.11.1 Reference Documentation

# QGeoSatelliteInfoSource Class

The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates. More...

Header: | `#include <QGeoSatelliteInfoSource>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Positioning)` `target_link_libraries(mytarget PRIVATE Qt6::Positioning)`
qmake: | `QT += positioning`
Inherits: | QObject
Inherited By: | QNmeaSatelliteInfoSource

- List of all members, including inherited members

## Public Types

enum | Error { AccessError, ClosedError, NoError, UnknownSourceError, UpdateTimeoutError }

## Properties

- minimumUpdateInterval : int
- updateInterval : int

## Public Functions

| QGeoSatelliteInfoSource(QObject *parent)
virtual | ~QGeoSatelliteInfoSource()
`(since 6.2)` virtual QVariant | backendProperty(const QString &name) const
QBindable<int> | bindableUpdateInterval()
virtual QGeoSatelliteInfoSource::Error | error() const = 0
virtual int | minimumUpdateInterval() const = 0
`(since 6.2)` virtual bool | setBackendProperty(const QString &name, const QVariant &value)
virtual void | setUpdateInterval(int msec)
QString | sourceName() const
int | updateInterval() const

## Public Slots

virtual void | requestUpdate(int timeout = 0) = 0
virtual void | startUpdates() = 0
virtual void | stopUpdates() = 0

## Signals

void | errorOccurred(QGeoSatelliteInfoSource::Error satelliteError)
void | satellitesInUseUpdated(const QList<QGeoSatelliteInfo> &satellites)
void | satellitesInViewUpdated(const QList<QGeoSatelliteInfo> &satellites)

## Static Public Members

QStringList | availableSources()
QGeoSatelliteInfoSource * | createDefaultSource(QObject *parent)
`(since Qt 5.14)` QGeoSatelliteInfoSource * | createDefaultSource(const QVariantMap &parameters, QObject *parent)
QGeoSatelliteInfoSource * | createSource(const QString &sourceName, QObject *parent)
`(since Qt 5.14)` QGeoSatelliteInfoSource * | createSource(const QString &sourceName, const QVariantMap &parameters, QObject *parent)

## Detailed Description

The static function QGeoSatelliteInfoSource::createDefaultSource() creates a default satellite data source that is appropriate for the platform, if one is available. Otherwise, available QGeoPositionInfoSourceFactory plugins will be checked for one that has a satellite data source available.

Call startUpdates() and stopUpdates() to start and stop regular updates, or requestUpdate() to request a single update. When an update is available, satellitesInViewUpdated() and/or satellitesInUseUpdated() will be emitted.

If regular satellite updates are required, setUpdateInterval() can be used to specify how often these updates should be emitted. If no interval is specified, updates are simply provided whenever they are available. For example:

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

To remove an update interval that was previously set, call setUpdateInterval() with a value of 0.

Note: The satellite source may have a minimum value requirement for update intervals, as returned by minimumUpdateInterval().

Note: To use this class from Android service, see Qt Positioning on Android.

## Member Type Documentation

### enum QGeoSatelliteInfoSource::Error

The Error enumeration represents the errors which can occur.

Constant | Value | Description
--- | --- | ---
`QGeoSatelliteInfoSource::AccessError` | `0` | The connection setup to the satellite backend failed because the application lacked the required privileges.
`QGeoSatelliteInfoSource::ClosedError` | `1` | The satellite backend closed the connection, which happens for example in case the user is switching location services to off. This object becomes invalid and should be deleted. A new satellite source can be created by calling createDefaultSource() later on.
`QGeoSatelliteInfoSource::NoError` | `2` | No error has occurred.
`QGeoSatelliteInfoSource::UnknownSourceError` | `-1` | An unidentified error occurred.
`QGeoSatelliteInfoSource::UpdateTimeoutError` | `3` | The current satellite information could not be retrieved within the specified timeout.

## Property Documentation

### `[read-only]` minimumUpdateInterval : int

This property holds the minimum time (in milliseconds) required to retrieve a satellite update.

This is the minimum value accepted by setUpdateInterval() and requestUpdate().

Access functions:

virtual int | minimumUpdateInterval() const = 0

### `[bindable]` updateInterval : int

Note: This property supports QProperty bindings.

This property holds the requested interval in milliseconds between each update.

If the update interval is not set (or is set to 0) the source will provide updates as often as necessary.

If the update interval is set, the source will provide updates at an interval as close to the requested interval as possible. If the requested interval is less than the minimumUpdateInterval(), the minimum interval is used instead.

Changes to the update interval will happen as soon as is practical, however the time the change takes may vary between implementations. Whether or not the elapsed time from the previous interval is counted as part of the new interval is also implementation dependent.

The default value for this property is 0.

Note: Subclass implementations must call the base implementation of setUpdateInterval() so that updateInterval() returns the correct value.

Access functions:

int | updateInterval() const
virtual void | setUpdateInterval(int msec)

## Member Function Documentation

### `[explicit]` QGeoSatelliteInfoSource::QGeoSatelliteInfoSource(QObject *parent)

Creates a satellite source with the specified parent.

### `[virtual noexcept]` 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().

### `[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.

### `[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.

### `[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.