QGeoAreaMonitorSource Class

メンバ関数のドキュメント

[explicit] QGeoAreaMonitorSource::QGeoAreaMonitorSource(QObject *parent)

指定されたparent を使用して、モニターソースを作成します。

[virtual noexcept] QGeoAreaMonitorSource::~QGeoAreaMonitorSource()

モニターソースを削除します。

[pure virtual] QList<QGeoAreaMonitorInfo> QGeoAreaMonitorSource::activeMonitors() const

QGeoAreaMonitorSource オブジェクトが認識している、すべてのアクティブなモニターのリストを返します。

アクティブなモニターは、startMonitoring() を通じて起動されます。各アクティブなモニターについて、ソースオブジェクトは、areaEntered() やareaExited() などの必要なシグナルを発行します。同じアプリケーション内の複数のQGeoAreaMonitorSource インスタンスは、同じアクティブなモニターオブジェクトを共有します。

QGeoAreaMonitorInfo がisPersistent() を実行していない限り、アクティブなQGeoAreaMonitorInfo は、現在のアプリケーションが終了すると停止します。

[pure virtual] QList<QGeoAreaMonitorInfo> QGeoAreaMonitorSource::activeMonitors(const QGeoShape &lookupArea) const

QGeoAreaMonitorSource オブジェクトが認識している、中心がlookupArea 内に位置するすべてのアクティブなモニターのリストを返します。lookupArea が空の場合、返されるリストも空になります。

アクティブなモニターは、startMonitoring() を通じて起動されます。各アクティブなモニターについて、ソースオブジェクトはareaEntered() やareaExited() などの必要なシグナルを発行します。同じアプリケーション内の複数のQGeoAreaMonitorSource インスタンスは、同じアクティブなモニターオブジェクトを共有します。

アクティブなQGeoAreaMonitorInfo がisPersistent()を実行しない限り、アクティブなQGeoAreaMonitorInfo は現在のアプリケーションが終了すると停止します。

QGeoShapeも参照してください 。

[signal] void QGeoAreaMonitorSource::areaEntered(const QGeoAreaMonitorInfo &monitor, const QGeoPositionInfo &update)

現在の位置が、アクティブなmonitor の外側にある位置から、監視エリア内の位置に移動した際に発行されます。

update には新しい位置情報が保持されます。

[signal] void QGeoAreaMonitorSource::areaExited(const QGeoAreaMonitorInfo &monitor, const QGeoPositionInfo &update)

現在の位置が、アクティブなmonitor 内の位置から、監視エリア外の位置に移動した際に発火します。

update には新しい位置情報が保持されます。

[static] QStringList QGeoAreaMonitorSource::availableSources()

利用可能なモニタープラグインのリストを返します。利用可能な場合は、デフォルトのシステムバックエンドも含まれます。

[virtual, since 6.2] QVariant QGeoAreaMonitorSource::backendProperty(const QString &name) const

name という名前のバックエンド固有のプロパティが存在する場合、その値を返します。存在しない場合、返される値は無効となります。

この関数は Qt 6.2 で導入されました。

setBackendProperty()も参照してください 。

[static] QGeoAreaMonitorSource *QGeoAreaMonitorSource::createDefaultSource(QObject *parent)

指定されたparent を持つモニターソースを作成し、それを返します。このモニターソースは、基盤となるシステム上のリソースを使用して領域を監視します。

システムが位置監視をサポートしていない場合、nullptr を返します。

[static] QGeoAreaMonitorSource *QGeoAreaMonitorSource::createSource(const QString &sourceName, QObject *parent)

指定されたparent を持つモニターソースを作成し、sourceName という名前のプラグインを読み込んで返します。

プラグインが見つからない場合は、nullptr を返します。

[pure virtual] QGeoAreaMonitorSource::Error QGeoAreaMonitorSource::error() const

最後に発生したエラーのタイプを返します。

[signal] void QGeoAreaMonitorSource::errorOccurred(QGeoAreaMonitorSource::Error areaMonitoringError)

この信号は、エラーが発生した後に発信されます。areaMonitoringError パラメータは、発生したエラーの種類を示します。

[signal] void QGeoAreaMonitorSource::monitorExpired(const QGeoAreaMonitorInfo &monitor)

monitor の有効期限が切れたときに発生します。有効期限が切れたエリアモニターは、activeMonitors()のリストから自動的に削除されます。

activeMonitors()も参照してください 。

[virtual] QGeoPositionInfoSource *QGeoAreaMonitorSource::positionInfoSource() const

このQGeoAreaMonitorSource オブジェクトによって現在使用されているQGeoPositionInfoSource を返します。他のオブジェクトが設定されていない場合、この関数はQGeoPositionInfoSource::createDefaultSource()を返します。

デフォルトのQGeoPositionInfoSource さえ存在しない場合、この関数はnullptr を返します。

返されたQGeoPositionInfoSource インスタンスを使用する際は、それが別のスレッドに存在している可能性があることに留意する必要があります。

QGeoPositionInfoSource およびsetPositionInfoSource()も参照してください 。

[pure virtual] bool QGeoAreaMonitorSource::requestUpdate(const QGeoAreaMonitorInfo &monitor, const char *signal)

シングルショットのエリアモニタリングを有効にします。monitor に対するエリアモニタリングは、このQGeoAreaMonitorSource インスタンスが初めてsignal を発信するまで実行されます。シグナルが発信されると、monitor はactiveMonitors()のリストから自動的に削除されます。monitor が無効であるか、有効期限が過ぎている場合、この関数はfalse を返します。

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

上記のsingleShotMonitor オブジェクトは、areaExited()シグナルが初めて発せられた時点で、更新の送信を停止します。この時点までは、エリアコンテキストに応じて、他のシグナルが0回以上発せられる可能性があります。

同じモニターオブジェクトの複数のシグナルに対して、同時に更新を要求することはできません。この関数への最後の呼び出しによって、更新が停止するシグナルが決定されます。この段階では、areaEntered() およびareaExited() シグナルのみが、モニタリングプロセスを終了するために使用できます。

QGeoAreaMonitorSource インスタンスに対する永続的なモニタリングを要求しても、エリアモニタリングバックエンドがQGeoAreaMonitorSource::PersistentAreaMonitorFeature をサポートしていない場合は失敗します。

monitor がすでにstartMonitoring()を介して登録されている場合、その動作はシングルショット動作に変換されます。

startMonitoring() およびstopMonitoring()も参照してください 。

[virtual, since 6.2] bool QGeoAreaMonitorSource::setBackendProperty(const QString &name, const QVariant &value)

name という名前のバックエンド固有のプロパティをvalue に設定します。成功した場合はtrue を返し、失敗した場合はfalse を返します。バックエンド固有のプロパティを使用することで、実行時に領域監視サブシステムの動作を設定することができます。

この関数は Qt 6.2 で導入されました。

backendProperty()も参照してください 。

[virtual] void QGeoAreaMonitorSource::setPositionInfoSource(QGeoPositionInfoSource *newSource)

このQGeoAreaMonitorSource オブジェクトが使用する新しいQGeoPositionInfoSource を設定します。エリアモニタリングバックエンドは、newSource の新しいQObject 親となります。以前のQGeoPositionInfoSource オブジェクトは削除されます。同じsourceName()に基づくすべてのQGeoAreaMonitorSource インスタンスは、同じQGeoPositionInfoSource インスタンスを共有します。

これは、エリア監視エンジンが使用する位置決めシステムを操作したい場合に役立つ可能性があります。

なお、所有権の管理はQGeoAreaMonitorSource のサブクラスが行う必要があります。このクラスの背後にあるシングルトンパターンのため、newSource は新しいスレッドに移動される可能性があります。

positionInfoSource()も参照してください 。

QString QGeoAreaMonitorSource::sourceName() const

使用中のエリアモニターソース実装の一意の名前を返します。

これは、特定のエリアモニターソース実装の新しいインスタンスを作成するために、createSource() に渡すことができるのと同じ名前です。

[pure virtual] bool QGeoAreaMonitorSource::startMonitoring(const QGeoAreaMonitorInfo &monitor)

monitor の監視を正常に開始できた場合は `true ` を返し、そうでない場合は `false` を返します。監視を開始できない理由として、適切なデフォルトの位置情報ソースが利用できないことが考えられます。この場合、setPositionInfoSource() を通じて代替の `QGeoPositionInfoSource ` が設定されていないことが原因である可能性があります。

monitor がすでにアクティブな場合、既存のモニターオブジェクトは新しいmonitor 参照に置き換えられます。QGeoAreaMonitorInfo インスタンスの識別はQGeoAreaMonitorInfo::identifier()を介して行われます。したがって、この関数はアクティブなモニターを更新するためにも使用できます。

monitor の有効期限が過ぎている場合、この関数はfalseを返します。requestUpdate()を介してすでに登録済みのシングルショット・モニターに対してこの関数を呼び出すと、モニターは永続的な監視モードに切り替わります。

QGeoAreaMonitorSource インスタンスに対して永続的な監視を要求しても、エリア監視バックエンドがQGeoAreaMonitorSource::PersistentAreaMonitorFeature をサポートしていない場合は失敗します。

stopMonitoring()も参照してください 。

[pure virtual] bool QGeoAreaMonitorSource::stopMonitoring(const QGeoAreaMonitorInfo &monitor)

monitor がactiveMonitors()のリストから正常に削除された場合はtrueを返し、そうでない場合はfalseを返します。この動作は、monitor がstartMonitoring()またはrequestUpdate()のいずれを介して登録されたかには依存しません。

[pure virtual] QGeoAreaMonitorSource::AreaMonitorFeatures QGeoAreaMonitorSource::supportedAreaMonitorFeatures() const

このソースで利用可能なエリア監視機能を返します。