QGeoSatelliteInfoSource

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

Inheritance diagram of PySide2.QtPositioning.QGeoSatelliteInfoSource

Synopsis

Functions

Virtual functions

Signals

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 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 that the satellite source may have a minimum value requirement for update intervals, as returned by minimumUpdateInterval() .

class PySide2.QtPositioning.QGeoSatelliteInfoSource(parent)
Parameters

parentPySide2.QtCore.QObject

PySide2.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.

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

list of strings

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

static PySide2.QtPositioning.QGeoSatelliteInfoSource.createDefaultSource(parent)
Parameters

parentPySide2.QtCore.QObject

Return type

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

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

PySide2.QtPositioning.QGeoSatelliteInfoSource

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

Returns 0 if the plugin cannot be found.

static PySide2.QtPositioning.QGeoSatelliteInfoSource.createSource(sourceName, parameters, parent)
Parameters
Return type

PySide2.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.

PySide2.QtPositioning.QGeoSatelliteInfoSource.error()
Return type

Error

Returns the last error that occurred.

This signal is not emitted when a requestTimeout() has occurred.

PySide2.QtPositioning.QGeoSatelliteInfoSource.error(arg__1)
Parameters

arg__1Error

PySide2.QtPositioning.QGeoSatelliteInfoSource.minimumUpdateInterval()
Return type

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() .

PySide2.QtPositioning.QGeoSatelliteInfoSource.requestTimeout()
PySide2.QtPositioning.QGeoSatelliteInfoSource.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() , requestTimeout() 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.

PySide2.QtPositioning.QGeoSatelliteInfoSource.satellitesInUseUpdated(satellites)
Parameters

satellites

PySide2.QtPositioning.QGeoSatelliteInfoSource.satellitesInViewUpdated(satellites)
Parameters

satellites

PySide2.QtPositioning.QGeoSatelliteInfoSource.setUpdateInterval(msec)
Parameters

msec – 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 so that returns the correct value.

PySide2.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.

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

PySide2.QtPositioning.QGeoSatelliteInfoSource.stopUpdates()

Stops emitting updates at regular intervals.

PySide2.QtPositioning.QGeoSatelliteInfoSource.updateInterval()
Return type

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 so that returns the correct value.