PySide6.QtPositioning.QGeoAreaMonitorInfo¶

class QGeoAreaMonitorInfo¶

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

Synopsis¶

Methods¶

def __init__()
def area()
def expiration()
def identifier()
def isPersistent()
def isValid()
def name()
def notificationParameters()
def __ne__()
def __eq__()
def setArea()
def setExpiration()
def setName()
def setNotificationParameters()
def setPersistent()
def swap()

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¶

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

See also

QGeoAreaMonitorSource

__init__(other)¶

Parameters:: other – QGeoAreaMonitorInfo

Constructs a QGeoAreaMonitorInfo object as a copy of other.

__init__([name=""])

Parameters:: name – str

Constructs a QGeoAreaMonitorInfo object with the specified name.

See also

name()

area()¶

Return type:: QGeoShape

Returns the boundaries of the to-be-monitored area. This area must not be empty.

See also

setArea()

expiration()¶

Return type:: QDateTime

Returns the expiry date.

After an active QGeoAreaMonitorInfo has expired the region is no longer monitored and the QGeoAreaMonitorInfo object is removed from the list of active monitors .

If the expiry QDateTime is invalid the QGeoAreaMonitorInfo object is treated as not having an expiry date. This implies an indefinite monitoring period if the object is persistent or until the current application closes if the object is non-persistent.

See also

setExpiration() activeMonitors()

identifier()¶

Return type:: str

Returns the identifier of the QGeoAreaMonitorInfo object. The identifier is automatically generated upon construction of a new QGeoAreaMonitorInfo object.

isPersistent()¶

Return type:: bool

Returns true if the QGeoAreaMonitorInfo is persistent. The default value for this property is false.

A non-persistent QGeoAreaMonitorInfo will be removed by the system once the application owning the monitor object stops. Persistent objects remain active and can be retrieved once the application restarts.

If the system triggers an event associated to a persistent QGeoAreaMonitorInfo the relevant application will be re-started and the appropriate signal emitted.

See also

setPersistent()

isValid()¶

Return type:: bool

Returns true, if the monitor is valid. A valid QGeoAreaMonitorInfo has a non-empty name() and the monitored area is not empty() . Otherwise this function returns false.

name()¶

Return type:: str

Returns the name of the QGeoAreaMonitorInfo object. The name should be used for user-visibility purposes.

See also

setName()

notificationParameters()¶

Return type:: Dictionary with keys of type .QString and values of type QVariant.

Returns the set of platform specific parameters used by this QGeoAreaMonitorInfo .

See also

setNotificationParameters()

__ne__(rhs)¶

Parameters:: rhs – QGeoAreaMonitorInfo
Return type:: bool

Returns true if any of the lhs object’s values are not the same as those of rhs object. Otherwise returns false.

__eq__(rhs)¶

Parameters:: rhs – QGeoAreaMonitorInfo
Return type:: bool

Returns true if all of the lhs object’s values are the same as those of rhs object. Otherwise returns false.

setArea(newShape)¶

Parameters:: newShape – QGeoShape

Sets the to-be-monitored area to newShape.

See also

area()

setExpiration(expiry)¶

Parameters:: expiry – QDateTime

Sets the expiry date and time to expiry.

See also

expiration()

setName(name)¶

Parameters:: name – str

Sets the user visibile name.

See also

name()

setNotificationParameters(parameters)¶

Parameters:: parameters – Dictionary with keys of type .QString and values of type QVariant.

Sets the set of platform specific parameters used by QGeoAreaMonitorInfo .

See also

notificationParameters()

setPersistent(isPersistent)¶

Parameters:: isPersistent – bool

Sets the QGeoAreaMonitorInfo object’s persistence to isPersistent.

Note that setting this flag does not imply that QGeoAreaMonitorSource supports persistent monitoring. supportedAreaMonitorFeatures() can be used to check for this feature’s availability.

See also

isPersistent()

swap(other)¶

Parameters:: other – QGeoAreaMonitorInfo

Swaps this QGeoAreaMonitorInfo object with other. This operation is very fast and never fails.