QGeoSatelliteInfoSource

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

Inheritance diagram of PySide6.QtPositioning.QGeoSatelliteInfoSource

Synopsis

Functions

Virtual functions

Static functions

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 and to start and stop regular updates, or to request a single update. When an update is available, and/or 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 PySide6.QtPositioning.QGeoSatelliteInfoSource(parent)
Parameters

parentPySide6.QtCore.QObject

PySide6.QtPositioning.QGeoSatelliteInfoSource.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.

static PySide6.QtPositioning.QGeoSatelliteInfoSource.availableSources()
Return type

list of strings

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

PySide6.QtPositioning.QGeoSatelliteInfoSource.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 PySide6.QtPositioning.QGeoSatelliteInfoSource.createDefaultSource(parameters, parent)
Parameters
Return type

PySide6.QtPositioning.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 PySide6.QtPositioning.QGeoSatelliteInfoSource.createDefaultSource(parent)
Parameters

parentPySide6.QtCore.QObject

Return type

PySide6.QtPositioning.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 PySide6.QtPositioning.QGeoSatelliteInfoSource.createSource(sourceName, parent)
Parameters
Return type

PySide6.QtPositioning.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 PySide6.QtPositioning.QGeoSatelliteInfoSource.createSource(sourceName, parameters, parent)
Parameters
Return type

PySide6.QtPositioning.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.

PySide6.QtPositioning.QGeoSatelliteInfoSource.error()
Return type

Error

PySide6.QtPositioning.QGeoSatelliteInfoSource.errorOccurred(arg__1)
Parameters

arg__1Error

PySide6.QtPositioning.QGeoSatelliteInfoSource.minimumUpdateInterval()
Return type

int

PySide6.QtPositioning.QGeoSatelliteInfoSource.requestUpdate([timeout=0])
Parameters

timeout – int

PySide6.QtPositioning.QGeoSatelliteInfoSource.satellitesInUseUpdated(satellites)
Parameters

satellites

PySide6.QtPositioning.QGeoSatelliteInfoSource.satellitesInViewUpdated(satellites)
Parameters

satellites

PySide6.QtPositioning.QGeoSatelliteInfoSource.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

PySide6.QtPositioning.QGeoSatelliteInfoSource.setUpdateInterval(msec)
Parameters

msec – int

See also

updateInterval()

PySide6.QtPositioning.QGeoSatelliteInfoSource.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.

PySide6.QtPositioning.QGeoSatelliteInfoSource.startUpdates()
PySide6.QtPositioning.QGeoSatelliteInfoSource.stopUpdates()
PySide6.QtPositioning.QGeoSatelliteInfoSource.updateInterval()
Return type

int