PySide6.QtPositioning.QGeoSatelliteInfoSource

class QGeoSatelliteInfoSource

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

Inheritance diagram of PySide6.QtPositioning.QGeoSatelliteInfoSource

Inherited by: QNmeaSatelliteInfoSource

Synopsis

Properties

  • minimumUpdateIntervalᅟ - This property holds the minimum time (in milliseconds) required to retrieve a satellite update

  • updateIntervalᅟ - This property holds the requested interval in milliseconds between each update

Methods

Virtual methods

Signals

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The static function 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 .

class Error

The Error enumeration represents the errors which can occur.

Constant

Description

QGeoSatelliteInfoSource.AccessError

The connection setup to the satellite backend failed because the application lacked the required privileges.

QGeoSatelliteInfoSource.ClosedError

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

No error has occurred.

QGeoSatelliteInfoSource.UnknownSourceError

An unidentified error occurred.

QGeoSatelliteInfoSource.UpdateTimeoutError

The current satellite information could not be retrieved within the specified timeout.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property minimumUpdateIntervalᅟ: int

This property holds 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:
property updateIntervalᅟ: int

This property holds 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:
__init__(parent)
Parameters:

parent – QObject

static availableSources()
Return type:

list of strings

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

backendProperty(name)
Parameters:

name – str

Return type:

object

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

static createDefaultSource(parent)
Parameters:

parent – QObject

Return type:

QGeoSatelliteInfoSource

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 createDefaultSource(parameters, parent)
Parameters:

  • parameters – Dictionary with keys of type .QString and values of type QVariant.

  • parent – QObject

Return type:

QGeoSatelliteInfoSource

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.

static createSource(sourceName, parent)
Parameters:

  • sourceName – str

  • parent – QObject

Return type:

QGeoSatelliteInfoSource

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

Returns nullptr if the plugin cannot be found.

static createSource(sourceName, parameters, parent)
Parameters:

  • sourceName – str

  • parameters – Dictionary with keys of type .QString and values of type QVariant.

  • parent – QObject

Return type:

QGeoSatelliteInfoSource

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.

abstract error()
Return type:

Error

Returns the last error that occurred.

Note

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

errorOccurred(satelliteError)
Parameters:

satelliteError – Error

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

abstract minimumUpdateInterval()
Return type:

int

Getter of property minimumUpdateIntervalᅟ .

abstract requestUpdate([timeout=0])
Parameters:

timeout – int

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 .

satellitesInUseUpdated(satellites)
Parameters:

satellites – .list of QGeoSatelliteInfo

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.

satellitesInViewUpdated(satellites)
Parameters:

satellites – .list of QGeoSatelliteInfo

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.

setBackendProperty(name, value)
Parameters:

  • name – str

  • value – object

Return type:

bool

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.

See also

backendProperty

setUpdateInterval(msec)
Parameters:

msec – int

See also

updateInterval()

Setter of property updateIntervalᅟ .

sourceName()
Return type:

str

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.

abstract 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() satellitesInUseUpdated()

abstract stopUpdates()

Stops emitting updates at regular intervals.

updateInterval()
Return type:

int

See also

setUpdateInterval()

Getter of property updateIntervalᅟ .