QGeoPositionInfoSource¶
The
QGeoPositionInfoSource
class is an abstract base class for the distribution of positional updates. More…
Inherited by: QNmeaPositionInfoSource
Synopsis¶
Functions¶
def
preferredPositioningMethods
()def
sourceName
()def
updateInterval
()
Virtual functions¶
def
error
()def
lastKnownPosition
([fromSatellitePositioningMethodsOnly=false])def
minimumUpdateInterval
()def
requestUpdate
([timeout=0])def
setPreferredPositioningMethods
(methods)def
setUpdateInterval
(msec)def
startUpdates
()def
stopUpdates
()def
supportedPositioningMethods
()
Signals¶
def
error
(arg__1)def
positionUpdated
(update)def
updateTimeout
()
Static functions¶
def
availableSources
()def
createDefaultSource
(parent)def
createSource
(sourceName, parent)
Detailed Description¶
The static function
createDefaultSource()
creates a default position source that is appropriate for the platform, if one is available. Otherwise,QGeoPositionInfoSource
will check for available plugins that implement theQGeoPositionInfoSourceFactory
interface.Users of a
QGeoPositionInfoSource
subclass can request the current position usingrequestUpdate()
, or start and stop regular position updates usingstartUpdates()
andstopUpdates()
. When an update is available,positionUpdated()
is emitted. The last known position can be accessed withlastKnownPosition()
.If regular position 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 QGeoPositionInfoSource *source = QGeoPositionInfoSource::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 position source may have a minimum value requirement for update intervals, as returned by
minimumUpdateInterval()
.
-
class
QGeoPositionInfoSource
(parent)¶ - param parent
QObject
Creates a position source with the specified
parent
.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
Error
¶ The Error enumeration represents the errors which can occur.
Constant
Description
QGeoPositionInfoSource.AccessError
The connection setup to the remote positioning backend failed because the application lacked the required privileges.
QGeoPositionInfoSource.ClosedError
The remote positioning backend closed the connection, which happens for example in case the user is switching location services to off. As soon as the location service is re-enabled regular updates will resume.
QGeoPositionInfoSource.NoError
No error has occurred.
QGeoPositionInfoSource.UnknownSourceError
An unidentified error occurred.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
PositioningMethod
¶ Defines the types of positioning methods.
Constant
Description
QGeoPositionInfoSource.NoPositioningMethods
None of the positioning methods.
QGeoPositionInfoSource.SatellitePositioningMethods
Satellite-based positioning methods such as GPS or GLONASS.
QGeoPositionInfoSource.NonSatellitePositioningMethods
Other positioning methods such as 3GPP cell identifier or WiFi based positioning.
QGeoPositionInfoSource.AllPositioningMethods
Satellite-based positioning methods as soon as available. Otherwise non-satellite based methods.
-
static
PySide2.QtPositioning.QGeoPositionInfoSource.
availableSources
()¶ - Return type
list of strings
Returns a list of available source plugins. This includes any default backend plugin for the current platform.
-
static
PySide2.QtPositioning.QGeoPositionInfoSource.
createDefaultSource
(parent)¶ - Parameters
parent –
QObject
- Return type
Creates and returns a position source with the given
parent
that reads from the system’s default sources of location data, or the plugin with the highest available priority.Returns 0 if the system has no default position source, no valid plugins could be found or the user does not have the permission to access the current position.
-
static
PySide2.QtPositioning.QGeoPositionInfoSource.
createSource
(sourceName, parent)¶ - Parameters
sourceName – unicode
parent –
QObject
- Return type
Creates and returns a position source with the given
parent
, by loading the plugin namedsourceName
.Returns 0 if the plugin cannot be found.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
error
()¶ - Return type
Returns the type of error that last occurred.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
error
(arg__1) - Parameters
arg__1 –
Error
-
PySide2.QtPositioning.QGeoPositionInfoSource.
lastKnownPosition
([fromSatellitePositioningMethodsOnly=false])¶ - Parameters
fromSatellitePositioningMethodsOnly –
bool
- Return type
Returns an update containing the last known position, or a null update if none is available.
If
fromSatellitePositioningMethodsOnly
is true, this returns the last known position received from a satellite positioning method; if none is available, a null update is returned.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
minimumUpdateInterval
()¶ - Return type
int
-
PySide2.QtPositioning.QGeoPositionInfoSource.
positionUpdated
(update)¶ - Parameters
update –
QGeoPositionInfo
-
PySide2.QtPositioning.QGeoPositionInfoSource.
preferredPositioningMethods
()¶ - Return type
PositioningMethods
Returns the positioning methods set by
setPreferredPositioningMethods()
.See also
-
PySide2.QtPositioning.QGeoPositionInfoSource.
requestUpdate
([timeout=0])¶ - Parameters
timeout –
int
Attempts to get the current position and emit
positionUpdated()
with this information. If the current position cannot be found within the giventimeout
(in milliseconds) or iftimeout
is less than the value returned byminimumUpdateInterval()
,updateTimeout()
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.If the source uses multiple positioning methods, it tries to get the current position from the most accurate positioning method within the given timeout.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
setPreferredPositioningMethods
(methods)¶ - Parameters
methods –
PositioningMethods
Sets the preferred positioning methods for this source to
methods
.If
methods
includes a method that is not supported by the source, the unsupported method will be ignored.If
methods
does not include a single method available/supported by the source, the preferred methods will be set to the set of methods which the source has available. If the source has no method availabe (e.g. because its Location service is turned off or it does not offer a Location service), the passedmethods
are accepted as they are.Note
When reimplementing this method, subclasses must call the base method implementation to ensure
preferredPositioningMethods()
returns the correct value.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
setUpdateInterval
(msec)¶ - Parameters
msec –
int
See also
-
PySide2.QtPositioning.QGeoPositionInfoSource.
sourceName
()¶ - Return type
unicode
-
PySide2.QtPositioning.QGeoPositionInfoSource.
startUpdates
()¶ Starts emitting updates at regular intervals as specified by
setUpdateInterval()
.If
setUpdateInterval()
has not been called, the source will emit updates as soon as they become available.An
updateTimeout()
signal will be emitted if thisQGeoPositionInfoSource
subclass determines that it will not be able to provide regular updates. This could happen if a satellite fix is lost or if a hardware error is detected. Position updates will recommence if the data becomes available later on. TheupdateTimeout()
signal will not be emitted again until after the periodic updates resume.On iOS, starting from version 8, Core Location framework requires additional entries in the application’s Info.plist with keys NSLocationAlwaysUsageDescription or NSLocationWhenInUseUsageDescription and a string to be displayed in the authorization prompt. The key NSLocationWhenInUseUsageDescription is used when requesting permission to use location services while the app is in the foreground. The key NSLocationAlwaysUsageDescription is used when requesting permission to use location services whenever the app is running (both the foreground and the background). If both entries are defined, NSLocationWhenInUseUsageDescription has a priority in the foreground mode.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
stopUpdates
()¶ Stops emitting updates at regular intervals.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
supportedPositioningMethods
()¶ - Return type
PositioningMethods
Returns the positioning methods available to this source. Availability is defined as being usable at the time of calling this function. Therefore user settings like turned off location service or limitations to Satellite-based position providers are reflected by this function. Runtime notifications when the status changes can be obtained via
supportedPositioningMethodsChanged()
.Not all platforms distinguish the different positioning methods or communicate the current user configuration of the device. The following table provides an overview of the current platform situation:
Platform
Brief Description
Android
Individual provider status and general Location service state are known and communicated when location service is active.
GeoClue
Hardcoced to always return
AllPositioningMethods
.GeoClue2
Individual providers are not distinguishable but disabled Location services reflected.
iOS/tvOS
Hardcoced to always return
AllPositioningMethods
.macOS
Hardcoced to always return
AllPositioningMethods
.Windows (UWP)
Individual providers are not distinguishable but disabled Location services reflected.
-
PySide2.QtPositioning.QGeoPositionInfoSource.
supportedPositioningMethodsChanged
()¶
-
PySide2.QtPositioning.QGeoPositionInfoSource.
updateInterval
()¶ - Return type
int
See also
-
PySide2.QtPositioning.QGeoPositionInfoSource.
updateTimeout
()¶
© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.