QGeoAreaMonitorInfo

The QGeoAreaMonitorInfo class describes the parameters of an area or region to be monitored for proximity. More

Inheritance diagram of PySide6.QtPositioning.QGeoAreaMonitorInfo

Synopsis

Functions

Detailed Description

The purpose of area monitoring is to inform a user when he/she comes close to an area of interest. In general such an area is described by a QGeoCircle . The circle’s center represents the place of interest and the area around it identifies the geographical region within which notifications are sent.

A QGeoAreaMonitorInfo object is valid if it has a non-empty name and a valid area(). Such objects must be registered with a QGeoAreaMonitorSource to start and stop the monitoring process. Note that extensive monitoring can be very resource consuming because the positioning engine must remain active and has to match the current position with each QGeoAreaMonitorInfo instance.

To further reduce the burden on the system there are optional attributes which can set. Each monitored area can have an expiry date which automatically removes the to-be-monitored area from the monitoring source once the expiry date has been reached. Another option is to adjust the persistence of a monitored area. A QGeoAreaMonitorInfo that isPersistent() will remain active beyond the current applications lifetime. If an area is entered while the monitoring application is not running the application will be started. Note that this feature is not available on all platforms. Its availability can be checked via QGeoAreaMonitorSource::supportedAreaMonitorFeatures().

class PySide6.QtPositioning.QGeoAreaMonitorInfo(other)

PySide6.QtPositioning.QGeoAreaMonitorInfo([name=””])

Parameters
PySide6.QtPositioning.QGeoAreaMonitorInfo.area()
Return type

PySide6.QtPositioning.QGeoShape

PySide6.QtPositioning.QGeoAreaMonitorInfo.expiration()
Return type

PySide6.QtCore.QDateTime

PySide6.QtPositioning.QGeoAreaMonitorInfo.identifier()
Return type

str

PySide6.QtPositioning.QGeoAreaMonitorInfo.isPersistent()
Return type

bool

PySide6.QtPositioning.QGeoAreaMonitorInfo.isValid()
Return type

bool

PySide6.QtPositioning.QGeoAreaMonitorInfo.name()
Return type

str

PySide6.QtPositioning.QGeoAreaMonitorInfo.notificationParameters()
Return type

PySide6.QtPositioning.QGeoAreaMonitorInfo.__ne__(rhs)
Parameters

rhsPySide6.QtPositioning.QGeoAreaMonitorInfo

Return type

bool

PySide6.QtPositioning.QGeoAreaMonitorInfo.__eq__(rhs)
Parameters

rhsPySide6.QtPositioning.QGeoAreaMonitorInfo

Return type

bool

PySide6.QtPositioning.QGeoAreaMonitorInfo.setArea(newShape)
Parameters

newShapePySide6.QtPositioning.QGeoShape

PySide6.QtPositioning.QGeoAreaMonitorInfo.setExpiration(expiry)
Parameters

expiryPySide6.QtCore.QDateTime

PySide6.QtPositioning.QGeoAreaMonitorInfo.setName(name)
Parameters

name – str

PySide6.QtPositioning.QGeoAreaMonitorInfo.setNotificationParameters(parameters)
Parameters

parameters

PySide6.QtPositioning.QGeoAreaMonitorInfo.setPersistent(isPersistent)
Parameters

isPersistent – bool

PySide6.QtPositioning.QGeoAreaMonitorInfo.swap(other)
Parameters

otherPySide6.QtPositioning.QGeoAreaMonitorInfo