\inmodule QtPositioning More...

#include <qgeoareamonitorinfo.h>

Collaboration diagram for QGeoAreaMonitorInfo:

Public Member Functions
	QGeoAreaMonitorInfo (const QString &name=QString())
	Constructs a QGeoAreaMonitorInfo object with the specified name.

	QGeoAreaMonitorInfo (const QGeoAreaMonitorInfo &other)
	Constructs a QGeoAreaMonitorInfo object as a copy of other.

	QGeoAreaMonitorInfo (QGeoAreaMonitorInfo &&other) noexcept=default

	~QGeoAreaMonitorInfo ()
	Destructor.

QGeoAreaMonitorInfo &	operator= (const QGeoAreaMonitorInfo &other)
	Assigns other to this QGeoAreaMonitorInfo object and returns a reference to this QGeoAreaMonitorInfo object.

void	swap (QGeoAreaMonitorInfo &other) noexcept

QString	name () const
	Returns the name of the QGeoAreaMonitorInfo object.

void	setName (const QString &name)
	Sets the user visibile name.

QString	identifier () const
	Returns the identifier of the QGeoAreaMonitorInfo object.

bool	isValid () const
	Returns true, if the monitor is valid.

QGeoShape	area () const
	Returns the boundaries of the to-be-monitored area.

void	setArea (const QGeoShape &newShape)
	Sets the to-be-monitored area to newShape.

QDateTime	expiration () const
	Returns the expiry date.

void	setExpiration (const QDateTime &expiry)
	Sets the expiry date and time to expiry.

bool	isPersistent () const
	Returns true if the QGeoAreaMonitorInfo is persistent.

void	setPersistent (bool isPersistent)
	Sets the QGeoAreaMonitorInfo object's persistence to isPersistent.

QVariantMap	notificationParameters () const
	Returns the set of platform specific parameters used by this QGeoAreaMonitorInfo.

void	setNotificationParameters (const QVariantMap &parameters)
	Sets the set of platform specific parameters used by QGeoAreaMonitorInfo.

void	detach ()

Friends
class	QGeoAreaMonitorInfoPrivate

bool	operator== (const QGeoAreaMonitorInfo &lhs, const QGeoAreaMonitorInfo &rhs)
	Returns `true` if all of the lhs object's values are the same as those of rhs object.

bool	operator!= (const QGeoAreaMonitorInfo &lhs, const QGeoAreaMonitorInfo &rhs)
	Returns `true` if any of the lhs object's values are not the same as those of rhs object.

QDataStream &	operator<< (QDataStream &ds, const QGeoAreaMonitorInfo &monitor)
	Writes the given monitor to the specified stream.

QDataStream &	operator>> (QDataStream &ds, QGeoAreaMonitorInfo &monitor)
	Reads a area monitoring data from the specified stream into the given monitor.

Q_POSITIONING_EXPORT size_t	qHash (const QGeoAreaMonitorInfo &key, size_t seed=0)

Q_POSITIONING_EXPORT char *	QTest::toString (const QGeoAreaMonitorInfo &info)

QDebug	operator<< (QDebug dbg, const QGeoAreaMonitorInfo &monitor)

Detailed Description

\inmodule QtPositioning

Since: 5.2

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

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 \l 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 \l area(). Such objects must be registered with a \l 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 \l 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 \l QGeoAreaMonitorSource::supportedAreaMonitorFeatures().

See also: QGeoAreaMonitorSource

Definition at line 27 of file qgeoareamonitorinfo.h.

Constructor & Destructor Documentation

◆ QGeoAreaMonitorInfo() [1/3]

QGeoAreaMonitorInfo::QGeoAreaMonitorInfo ( const QString & name = QString() )

explicit

Constructs a QGeoAreaMonitorInfo object with the specified name.

See also: name()

Definition at line 82 of file qgeoareamonitorinfo.cpp.

◆ QGeoAreaMonitorInfo() [2/3]

QGeoAreaMonitorInfo::QGeoAreaMonitorInfo ( const QGeoAreaMonitorInfo & other )

Constructs a QGeoAreaMonitorInfo object as a copy of other.

Definition at line 92 of file qgeoareamonitorinfo.cpp.

◆ QGeoAreaMonitorInfo() [3/3]

QGeoAreaMonitorInfo::QGeoAreaMonitorInfo ( QGeoAreaMonitorInfo && other )

defaultnoexcept

Since: 6.2

Constructs a QGeoAreaMonitorInfo object by moving from other.

Note that a moved-from QGeoAreaMonitorInfo can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

◆ ~QGeoAreaMonitorInfo()

QGeoAreaMonitorInfo::~QGeoAreaMonitorInfo ( )

Destructor.

Definition at line 111 of file qgeoareamonitorinfo.cpp.

Member Function Documentation

◆ area()

QGeoShape QGeoAreaMonitorInfo::area ( ) const

Returns the boundaries of the to-be-monitored area.

This area must not be empty.

See also: setArea()

Definition at line 205 of file qgeoareamonitorinfo.cpp.

◆ detach()

void QGeoAreaMonitorInfo::detach ( )

Definition at line 308 of file qgeoareamonitorinfo.cpp.

◆ expiration()

QDateTime QGeoAreaMonitorInfo::expiration ( ) const

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 \l {QGeoAreaMonitorSource::activeMonitors()}{active monitors}.

If the expiry \l 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: QGeoAreaMonitorSource::activeMonitors()

Definition at line 234 of file qgeoareamonitorinfo.cpp.

◆ identifier()

QString QGeoAreaMonitorInfo::identifier ( ) const

Returns the identifier of the QGeoAreaMonitorInfo object.

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

Definition at line 185 of file qgeoareamonitorinfo.cpp.

◆ isPersistent()

bool QGeoAreaMonitorInfo::isPersistent ( ) const

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

Definition at line 261 of file qgeoareamonitorinfo.cpp.

◆ isValid()

bool QGeoAreaMonitorInfo::isValid ( ) const

Returns true, if the monitor is valid.

A valid QGeoAreaMonitorInfo has a non-empty name() and the monitored area is not \l {QGeoShape::isEmpty()}{empty()}. Otherwise this function returns false.

Definition at line 195 of file qgeoareamonitorinfo.cpp.

◆ name()

QString QGeoAreaMonitorInfo::name ( ) const

Returns the name of the QGeoAreaMonitorInfo object.

The name should be used for user-visibility purposes.

Definition at line 163 of file qgeoareamonitorinfo.cpp.

◆ notificationParameters()

QVariantMap QGeoAreaMonitorInfo::notificationParameters ( ) const

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

See also: setNotificationParameters()

Definition at line 289 of file qgeoareamonitorinfo.cpp.

◆ operator=()

QGeoAreaMonitorInfo & QGeoAreaMonitorInfo::operator= ( const QGeoAreaMonitorInfo & other )

Assigns other to this QGeoAreaMonitorInfo object and returns a reference to this QGeoAreaMonitorInfo object.

Since: 6.2

Move-assigns other to this QGeoAreaMonitorInfo object and returns a reference to this QGeoAreaMonitorInfo object.

Note that a moved-from QGeoAreaMonitorInfo can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

Definition at line 121 of file qgeoareamonitorinfo.cpp.

◆ setArea()

void QGeoAreaMonitorInfo::setArea ( const QGeoShape & newShape )

Sets the to-be-monitored area to newShape.

See also: area()

Definition at line 215 of file qgeoareamonitorinfo.cpp.

◆ setExpiration()

void QGeoAreaMonitorInfo::setExpiration ( const QDateTime & expiry )

Sets the expiry date and time to expiry.

Definition at line 242 of file qgeoareamonitorinfo.cpp.

◆ setName()

void QGeoAreaMonitorInfo::setName ( const QString & name )

Sets the user visibile name.

Definition at line 171 of file qgeoareamonitorinfo.cpp.

◆ setNotificationParameters()

void QGeoAreaMonitorInfo::setNotificationParameters ( const QVariantMap & parameters )

Sets the set of platform specific parameters used by QGeoAreaMonitorInfo.

See also: notificationParameters()

Definition at line 299 of file qgeoareamonitorinfo.cpp.

◆ setPersistent()

void QGeoAreaMonitorInfo::setPersistent ( bool isPersistent )

Sets the QGeoAreaMonitorInfo object's persistence to isPersistent.

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

See also: isPersistent()

Definition at line 276 of file qgeoareamonitorinfo.cpp.

◆ swap()

void QGeoAreaMonitorInfo::swap ( QGeoAreaMonitorInfo & other )

inlinenoexcept

Since: 6.2 \memberswap{QGeoAreaMonitorInfo object}

Definition at line 38 of file qgeoareamonitorinfo.h.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const QGeoAreaMonitorInfo &	lhs,
		const QGeoAreaMonitorInfo &	rhs )

friend

Returns true if any of the lhs object's values are not the same as those of rhs object.

Otherwise returns false.

Definition at line 44 of file qgeoareamonitorinfo.h.

◆ operator<< [1/2]

QDataStream & operator<<	(	QDataStream &	stream,
		const QGeoAreaMonitorInfo &	monitor )

friend

Writes the given monitor to the specified stream.

See also: {Serializing Qt Data Types}

Definition at line 75 of file qgeoareamonitorinfo.h.

◆ operator<< [2/2]

QDebug operator<<	(	QDebug	dbg,
		const QGeoAreaMonitorInfo &	monitor )

friend

Definition at line 89 of file qgeoareamonitorinfo.h.

◆ operator==

bool operator==	(	const QGeoAreaMonitorInfo &	lhs,
		const QGeoAreaMonitorInfo &	rhs )

friend

Returns true if all of the lhs object's values are the same as those of rhs object.

Otherwise returns false.

Definition at line 40 of file qgeoareamonitorinfo.h.

◆ operator>>

QDataStream & operator>>	(	QDataStream &	stream,
		QGeoAreaMonitorInfo &	monitor )

friend

Reads a area monitoring data from the specified stream into the given monitor.

See also: {Serializing Qt Data Types}

Definition at line 79 of file qgeoareamonitorinfo.h.

◆ QGeoAreaMonitorInfoPrivate

friend class QGeoAreaMonitorInfoPrivate

friend

Definition at line 72 of file qgeoareamonitorinfo.h.

◆ qHash

Q_POSITIONING_EXPORT size_t qHash	(	const QGeoAreaMonitorInfo &	key,
		size_t	seed = 0 )

friend

Definition at line 394 of file qgeoareamonitorinfo.cpp.

◆ QTest::toString

Q_POSITIONING_EXPORT char * QTest::toString ( const QGeoAreaMonitorInfo & info )

friend

The documentation for this class was generated from the following files:

qtpositioning/src/positioning/qgeoareamonitorinfo.h (503723f0699911cd54d68e4f3379486ce54b01b3)
qtpositioning/src/positioning/qgeoareamonitorinfo.cpp (346d425ba37f3ca9df3f7e6843de82a70eb72b7d)

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QGeoAreaMonitorInfo() [1/3]

◆ QGeoAreaMonitorInfo() [2/3]

◆ QGeoAreaMonitorInfo() [3/3]

◆ ~QGeoAreaMonitorInfo()

Member Function Documentation

◆ area()

◆ detach()

◆ expiration()

◆ identifier()

◆ isPersistent()

◆ isValid()

◆ name()

◆ notificationParameters()

◆ operator=()

◆ setArea()

◆ setExpiration()

◆ setName()

◆ setNotificationParameters()

◆ setPersistent()

◆ swap()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<< [1/2]

◆ operator<< [2/2]

◆ operator==

◆ operator>>

◆ QGeoAreaMonitorInfoPrivate

◆ qHash

◆ QTest::toString