QGeoAreaMonitorSource

The QGeoAreaMonitorSource class enables the detection of proximity changes for a specified set of coordinates. More…

Synopsis

Functions

• def sourceName ()

Virtual functions

• def activeMonitors (lookupArea)

• def activeMonitors ()

• def backendProperty (name)

• def error ()

• def positionInfoSource ()

• def requestUpdate (monitor, signal)

• def setBackendProperty (name, value)

• def setPositionInfoSource (source)

• def startMonitoring (monitor)

• def stopMonitoring (monitor)

• def supportedAreaMonitorFeatures ()

Signals

• def areaEntered (monitor, update)

• def areaExited (monitor, update)

• def errorOccurred (error)

• def monitorExpired (monitor)

Static functions

• def availableSources ()

• def createDefaultSource (parent)

• def createSource (sourceName, parent)

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

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

A QGeoAreaMonitorSource emits signals when the current position is in range, or has moved out of range, of a specified area. Each area is specified by a QGeoAreaMonitorInfo object. For example:

# public
    MyClass() : QObject()

        monitor = QGeoAreaMonitorSource.createDefaultSource(self)
        if monitor:
            connect(monitor, SIGNAL(areaEntered(QGeoAreaMonitorInfo,QGeoPositionInfo)),
                    self, SLOT(areaEntered(QGeoAreaMonitorInfo,QGeoPositionInfo)))
            connect(monitor, SIGNAL(areaExited(QGeoAreaMonitorInfo,QGeoPositionInfo)),
                    self, SLOT(areaExited(QGeoAreaMonitorInfo,QGeoPositionInfo)))
            bigBen = QGeoAreaMonitorInfo("Big Ben")
            position = QGeoCoordinate(51.50104, -0.124632)
            bigBen.setArea(QGeoCircle(position, 100))
            monitor.startMonitoring(bigBen)
        else:
            print("Could not create default area monitor")


public Q_SLOTS:
    def areaEntered(mon, update):

        Q_UNUSED(mon)
        print("Now within 100 meters, current position is", update.coordinate())

    def areaExited(mon, update):

        Q_UNUSED(mon)
        print("No longer within 100 meters, current position is", update.coordinate())

QGeoAreaMonitorSource follows a singleton pattern. Each instance of the class with the same sourceName() shares the same area monitoring backend. If a new QGeoAreaMonitorInfo object is added via startMonitoring() or requestUpdate() it can be retrieved by another instance of this class (provided that they are sourced from the same area monitor provider plug-in). The same singleton pattern applies to the QGeoPositionInfoSource instance used by this class. The following code snippet emphasizes the behavior:

QGeoAreaMonitorSource *s1 = QGeoAreaMonitorSource::createSource("blah", this);
QGeoAreaMonitorSource *s2 = QGeoAreaMonitorSource::createSource("blah", this);
QVERIFY(s1->positionInfoSource() == s2->positionInfoSource);

class PySide6.QtPositioning.QGeoAreaMonitorSource(parent)

Parameters:

parent – PySide6.QtCore.QObject

Creates a monitor source with the given parent.

PySide6.QtPositioning.QGeoAreaMonitorSource.Error

Defines the types of positioning methods.

The Error enumeration represents the errors which can occur.

Constant	Description
QGeoAreaMonitorSource.AccessError	The connection setup to the remote area monitoring backend failed because the application lacked the required privileges.
QGeoAreaMonitorSource.InsufficientPositionInfo	The area monitoring source could not retrieve a location fix or the accuracy of the fix is not high enough to provide an effective area monitoring.
QGeoAreaMonitorSource.NoError	No error has occurred.
QGeoAreaMonitorSource.UnknownSourceError	An unidentified error occurred.

PySide6.QtPositioning.QGeoAreaMonitorSource.AreaMonitorFeature

(inherits enum.Flag) Defines the types of area monitoring capabilities.

Constant	Description
QGeoAreaMonitorSource.PersistentAreaMonitorFeature	QGeoAreaMonitorInfo instances can be made persistent. A persistent monitor continues to be active even when the application managing the monitor is not running.
QGeoAreaMonitorSource.AnyAreaMonitorFeature	Matches all possible area monitoring features.

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.activeMonitors(lookupArea)

Parameters:

lookupArea – PySide6.QtPositioning.QGeoShape

Returns the list of all active monitors known to the QGeoAreaMonitorSource object whose center lies within lookupArea. If lookupArea is empty the returned list will be empty.

An active monitor was started via startMonitoring() . For every active monitor the source object will emit the required signals, such as areaEntered() or areaExited() . Multiple QGeoAreaMonitorSource instances within the same application share the same active monitor objects.

Unless an active QGeoAreaMonitorInfo isPersistent() an active QGeoAreaMonitorInfo will be stopped once the current application terminates.

See also

QGeoShape

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.activeMonitors()

Returns the list of all active monitors known to the QGeoAreaMonitorSource object.

An active monitor was started via startMonitoring() . For every active monitor the source object will emit the required signals, such as areaEntered() or areaExited() . Multiple QGeoAreaMonitorSource instances within the same application share the same active monitor objects.

Unless an active QGeoAreaMonitorInfo isPersistent() an active QGeoAreaMonitorInfo will be stopped once the current application terminates.

PySide6.QtPositioning.QGeoAreaMonitorSource.areaEntered(monitor, update)

Parameters:

• monitor – PySide6.QtPositioning.QGeoAreaMonitorInfo

• update – PySide6.QtPositioning.QGeoPositionInfo

Emitted when the current position has moved from a position outside of the active monitor to a position within the monitored area.

The update holds the new position.

PySide6.QtPositioning.QGeoAreaMonitorSource.areaExited(monitor, update)

Parameters:

• monitor – PySide6.QtPositioning.QGeoAreaMonitorInfo

• update – PySide6.QtPositioning.QGeoPositionInfo

Emitted when the current position has moved from a position within the active monitor to a position outside the monitored area.

The update holds the new position.

static PySide6.QtPositioning.QGeoAreaMonitorSource.availableSources()

Return type:

list of strings

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

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

See also

setBackendProperty()

static PySide6.QtPositioning.QGeoAreaMonitorSource.createDefaultSource(parent)

Parameters:

parent – PySide6.QtCore.QObject

Return type:

PySide6.QtPositioning.QGeoAreaMonitorSource

Creates and returns a monitor source with the given parent that monitors areas using resources on the underlying system.

Returns nullptr if the system has no support for position monitoring.

static PySide6.QtPositioning.QGeoAreaMonitorSource.createSource(sourceName, parent)

Parameters:

• sourceName – str

• parent – PySide6.QtCore.QObject

Return type:

PySide6.QtPositioning.QGeoAreaMonitorSource

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

Returns nullptr if the plugin cannot be found.

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.error()

Return type:

Error

Returns the type of error that last occurred.

Note

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

PySide6.QtPositioning.QGeoAreaMonitorSource.errorOccurred(error)

Parameters:

error – Error

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

PySide6.QtPositioning.QGeoAreaMonitorSource.monitorExpired(monitor)

Parameters:

monitor – PySide6.QtPositioning.QGeoAreaMonitorInfo

Emitted when monitor has expired. An expired area monitor is automatically removed from the list of activeMonitors() .

See also

activeMonitors()

PySide6.QtPositioning.QGeoAreaMonitorSource.positionInfoSource()

Return type:

PySide6.QtPositioning.QGeoPositionInfoSource

Returns the current QGeoPositionInfoSource used by this QGeoAreaMonitorSource object. The function will return createDefaultSource() if no other object has been set.

The function returns nullptr if not even a default QGeoPositionInfoSource exists.

Any usage of the returned QGeoPositionInfoSource instance should account for the fact that it may reside in a different thread.

See also

QGeoPositionInfoSource setPositionInfoSource()

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.requestUpdate(monitor, signal)

Parameters:

• monitor – PySide6.QtPositioning.QGeoAreaMonitorInfo

• signal – str

Return type:

bool

Enables single shot area monitoring. Area monitoring for monitor will be performed until this QGeoAreaMonitorSource instance emits signal for the first time. Once the signal was emitted, monitor is automatically removed from the list of activeMonitors() . If monitor is invalid or has an expiry date that has been passed, this function returns false.

QGeoAreaMonitor singleShotMonitor;
QGeoAreaMonitorSource * source = QGeoAreaMonitorSource::createDefaultSource(this);
//...
bool ret = source->requestUpdate(singleShotMonitor,
                      SIGNAL(areaExited(QGeoAreaMonitor,QGeoPositionInfo)));

The above singleShotMonitor object will cease to send updates once the areaExited() signal was emitted for the first time. Until this point in time any other signal may be emitted zero or more times depending on the area context.

It is not possible to simultanously request updates for more than one signal of the same monitor object. The last call to this function determines the signal upon which the updates cease to continue. At this stage only the areaEntered() and areaExited() signals can be used to terminate the monitoring process.

Requesting persistent monitoring on a QGeoAreaMonitorSource instance fails if the area monitoring backend doesn’t support PersistentAreaMonitorFeature .

If monitor was already registered via startMonitoring() it is converted to a single shot behavior.

Note

Since Qt6 this method always resets the last error to NoError before starting monitoring.

See also

startMonitoring() stopMonitoring()

PySide6.QtPositioning.QGeoAreaMonitorSource.setBackendProperty(name, value)

Parameters:

• name – str

• value – object

Return type:

bool

Sets the backend-specific property named name to value. Returns true on success, otherwise returns false. Backend-specific properties can be used to configure the area monitoring subsystem behavior at runtime.

See also

backendProperty()

PySide6.QtPositioning.QGeoAreaMonitorSource.setPositionInfoSource(source)

Parameters:

source – PySide6.QtPositioning.QGeoPositionInfoSource

Sets the new QGeoPositionInfoSource to be used by this QGeoAreaMonitorSource object. The area monitoring backend becomes the new QObject parent for newSource. The previous QGeoPositionInfoSource object will be deleted. All QGeoAreaMonitorSource instances based on the same sourceName() share the same QGeoPositionInfoSource instance.

This may be useful when it is desirable to manipulate the positioning system used by the area monitoring engine.

Note that ownership must be taken care of by subclasses of QGeoAreaMonitorSource . Due to the singleton pattern behind this class newSource may be moved to a new thread.

See also

positionInfoSource()

PySide6.QtPositioning.QGeoAreaMonitorSource.sourceName()

Return type:

str

Returns the unique name of the area monitor 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 area monitor source implementation.

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.startMonitoring(monitor)

Parameters:

monitor – PySide6.QtPositioning.QGeoAreaMonitorInfo

Return type:

bool

Returns true if the monitoring of monitor could be successfully started; otherwise returns false. A reason for not being able to start monitoring could be the unavailability of an appropriate default position info source while no alternative QGeoPositionInfoSource has been set via setPositionInfoSource() .

If monitor is already active, the existing monitor object will be replaced by the new monitor reference. The identification of QGeoAreaMonitorInfo instances happens via identifier() . Therefore this function can also be used to update active monitors.

If monitor has an expiry date that has been passed this function returns false. Calling this function for an already via requestUpdate() registered single shot monitor switches the monitor to a permanent monitoring mode.

Requesting persistent monitoring on a QGeoAreaMonitorSource instance fails if the area monitoring backend doesn’t support PersistentAreaMonitorFeature .

Note

Since Qt6 this method always resets the last error to NoError before starting monitoring.

See also

stopMonitoring()

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.stopMonitoring(monitor)

Parameters:

monitor – PySide6.QtPositioning.QGeoAreaMonitorInfo

Return type:

bool

Returns true if monitor was successfully removed from the list of activeMonitors() ; otherwise returns false. This behavior is independent on whether monitor was registered via startMonitoring() or requestUpdate() .

abstract PySide6.QtPositioning.QGeoAreaMonitorSource.supportedAreaMonitorFeatures()

Return type:

AreaMonitorFeatures

Returns the area monitoring features available to this source.