QGeoServiceProvider Class
QGeoServiceProvider クラスは、地理情報を提供するサービスへのアクセスを集約します。詳細...
Header: | #include <QGeoServiceProvider> |
qmake: | QT += location |
Inherits: | QObject |
パブリック型
enum | Error { NoError, NotSupportedError, UnknownParameterError, MissingRequiredParameterError, ConnectionError, LoaderError } |
enum | GeocodingFeature { NoGeocodingFeatures, OnlineGeocodingFeature, OfflineGeocodingFeature, ReverseGeocodingFeature, LocalizedGeocodingFeature, AnyGeocodingFeatures } |
flags | GeocodingFeatures |
enum | MappingFeature { NoMappingFeatures, OnlineMappingFeature, OfflineMappingFeature, LocalizedMappingFeature, AnyMappingFeatures } |
flags | MappingFeatures |
enum | NavigationFeature { NoNavigationFeatures, OnlineNavigationFeature, OfflineNavigationFeature, AnyNavigationFeatures } |
flags | NavigationFeatures |
enum | PlacesFeature { NoPlacesFeatures, OnlinePlacesFeature, OfflinePlacesFeature, SavePlaceFeature, RemovePlaceFeature, …, AnyPlacesFeatures } |
flags | PlacesFeatures |
enum | RoutingFeature { NoRoutingFeatures, OnlineRoutingFeature, OfflineRoutingFeature, LocalizedRoutingFeature, RouteUpdatesFeature, …, AnyRoutingFeatures } |
flags | RoutingFeatures |
パブリック関数
QGeoServiceProvider(const QString &providerName, const QVariantMap ¶meters = QVariantMap(), bool allowExperimental = false) | |
virtual | ~QGeoServiceProvider() |
QGeoServiceProvider::Error | error() const |
QString | errorString() const |
QGeoServiceProvider::Error | geocodingError() const |
QString | geocodingErrorString() const |
QGeoServiceProvider::GeocodingFeatures | geocodingFeatures() const |
QGeoCodingManager * | geocodingManager() const |
QGeoServiceProvider::Error | mappingError() const |
QString | mappingErrorString() const |
QGeoServiceProvider::MappingFeatures | mappingFeatures() const |
QGeoServiceProvider::Error | navigationError() const |
QString | navigationErrorString() const |
(since QtLocation 5.11) QGeoServiceProvider::NavigationFeatures | navigationFeatures() const |
QPlaceManager * | placeManager() const |
QGeoServiceProvider::Error | placesError() const |
QString | placesErrorString() const |
QGeoServiceProvider::PlacesFeatures | placesFeatures() const |
QGeoServiceProvider::Error | routingError() const |
QString | routingErrorString() const |
QGeoServiceProvider::RoutingFeatures | routingFeatures() const |
QGeoRoutingManager * | routingManager() const |
void | setAllowExperimental(bool allow) |
void | setLocale(const QLocale &locale) |
void | setParameters(const QVariantMap ¶meters) |
静的パブリック・メンバー
QStringList | availableServiceProviders() |
詳細説明
Maps and Navigation API を使用すると、ジオコーディング、ルーティング、地図の表示など、さまざまな種類の地理情報にアクセスできます。QGeoServiceProvider は、単一のベンダーによって提供されるこれらのサービスのセットへのアクセスを集約します。
あるサービスプロバイダーのジオコーディングマネージャーを、別のサービスプロバイダーのジオグラフィックルーティングマネージャーと一緒に使用できるように、さまざまなドメインのサービスプロバイダーを混ぜて使用することが可能です。
これは、異なるサービスによって提供されるデータに互換性があることをクライアントが確認できない限り、推奨されない。
QGeoServiceProvider のサブクラスは、提供するさまざまなサービスの相互運用性を保証します。
各サービス プロバイダは、サービス固有のパラメータ名/キーの命名規則に従わなければならない。プロバイダーは、すべてのパラメーター名のプレフィックスとしてプロバイダー名を使用します。プロバイダーがロードされると、プロバイダー名で始まるパラメーター名だけが渡されます。これにより、機密のtoken
やapp_id
パラメータなど、機密性の高いパラメータを他のプラグインと共有することを避けることができます。
利用可能なパラメータ名/キーと値の完全なリストを取得するには、GeoServices プラグイン固有のドキュメントを確認してください。
メンバータイプのドキュメント
enum QGeoServiceProvider::Error
サービスプロバイダプラグインのロードとセットアップに関連するエラーについて説明します。
定数 | 値 | 説明 |
---|---|---|
QGeoServiceProvider::NoError | 0 | エラーは発生していません。 |
QGeoServiceProvider::NotSupportedError | 1 | プラグインはこの機能をサポートしていません。 |
QGeoServiceProvider::UnknownParameterError | 2 | プラグインが指定されたパラメータを認識できませんでした。 |
QGeoServiceProvider::MissingRequiredParameterError | 3 | プラグインが指定したパラメータが見つかりません。 |
QGeoServiceProvider::ConnectionError | 4 | プラグインがバックエンドのサービスまたはデータベースに接続できませんでした。 |
QGeoServiceProvider::LoaderError | 5 | プラグインのロードに失敗しました。 |
enum QGeoServiceProvider::GeocodingFeature
flags QGeoServiceProvider::GeocodingFeatures
ジオサービスプロバイダがサポートするジオコーディング機能について説明します。
定数 | 値 | 説明 |
---|---|---|
QGeoServiceProvider::NoGeocodingFeatures | 0 | ジオコーディング機能はサポートされていません。 |
QGeoServiceProvider::OnlineGeocodingFeature | (1<<0) | オンラインジオコーディングがサポートされている。 |
QGeoServiceProvider::OfflineGeocodingFeature | (1<<1) | オフラインジオコーディングがサポートされています。 |
QGeoServiceProvider::ReverseGeocodingFeature | (1<<2) | リバース・ジオコーディングに対応しています。 |
QGeoServiceProvider::LocalizedGeocodingFeature | (1<<3) | ローカライズされた住所でのジオコーディング結果の返送をサポートしています。 |
QGeoServiceProvider::AnyGeocodingFeatures | ~(0) | 任意のジオコーディング機能を提供するジオサービスプロバイダにマッチする。 |
GeocodingFeatures 型はQFlags<GeocodingFeature> の typedef である。GeocodingFeature 値の OR の組み合わせを格納する。
enum QGeoServiceProvider::MappingFeature
flags QGeoServiceProvider::MappingFeatures
ジオサービスプロバイダがサポートするマッピング機能について説明します。
定数 | 値 | 説明 |
---|---|---|
QGeoServiceProvider::NoMappingFeatures | 0 | マッピング機能はサポートされていません。 |
QGeoServiceProvider::OnlineMappingFeature | (1<<0) | オンラインマッピングがサポートされています。 |
QGeoServiceProvider::OfflineMappingFeature | (1<<1) | オフラインマッピングがサポートされています。 |
QGeoServiceProvider::LocalizedMappingFeature | (1<<2) | ローカライズされた地図データの返送をサポートしています。 |
QGeoServiceProvider::AnyMappingFeatures | ~(0) | マッピング機能を提供するジオ・サービス・プロバイダーにマッチします。 |
MappingFeatures 型はQFlags<MappingFeature> の typedef です。MappingFeatures 値の OR の組み合わせを格納します。
enum QGeoServiceProvider::NavigationFeature
flags QGeoServiceProvider::NavigationFeatures
ジオサービスプロバイダーがサポートするナビゲーション機能について説明します。
定数 | 値 | 説明 |
---|---|---|
QGeoServiceProvider::NoNavigationFeatures | 0 | ナビゲーション機能はサポートされていません。 |
QGeoServiceProvider::OnlineNavigationFeature | (1<<0) | オンラインナビゲーションがサポートされています。 |
QGeoServiceProvider::OfflineNavigationFeature | (1<<1) | オフラインナビゲーションがサポートされています。 |
QGeoServiceProvider::AnyNavigationFeatures | ~(0) | ナビゲーション機能を提供するジオ・サービス・プロバイダーにマッチする。 |
NavigationFeatures型はQFlags<NavigationFeature>のtypedefである。これは、NavigationFeature 値の OR の組み合わせを格納する。
enum QGeoServiceProvider::PlacesFeature
flags QGeoServiceProvider::PlacesFeatures
ジオサービスプロバイダーがサポートする場所機能について説明します。
定数 | 値 | 説明 |
---|---|---|
QGeoServiceProvider::NoPlacesFeatures | 0 | 場所機能はサポートされていません。 |
QGeoServiceProvider::OnlinePlacesFeature | (1<<0) | オンラインの場所がサポートされている。 |
QGeoServiceProvider::OfflinePlacesFeature | (1<<1) | オフラインの場所がサポートされています。 |
QGeoServiceProvider::SavePlaceFeature | (1<<2) | 場所の保存がサポートされています。 |
QGeoServiceProvider::RemovePlaceFeature | (1<<3) | 場所の削除がサポートされています。 |
QGeoServiceProvider::SaveCategoryFeature | (1<<4) | カテゴリの保存がサポートされています。 |
QGeoServiceProvider::RemoveCategoryFeature | (1<<5) | カテゴリの削除がサポートされています。 |
QGeoServiceProvider::PlaceRecommendationsFeature | (1<<6) | 他の場所に似ているお勧めの場所の検索がサポートされています。 |
QGeoServiceProvider::SearchSuggestionsFeature | (1<<7) | 検索候補をサポートしました。 |
QGeoServiceProvider::LocalizedPlacesFeature | (1<<8) | ローカライズされた場所データを返すことができます。 |
QGeoServiceProvider::NotificationsFeature | (1<<9) | 場所とカテゴリの変更の通知がサポートされています。 |
QGeoServiceProvider::PlaceMatchingFeature | (1<<10) | 2つの異なるジオサービスプロバイダの場所のマッチングをサポートします。 |
QGeoServiceProvider::AnyPlacesFeatures | ~(0) | 任意の場所の特徴を提供するジオサービスプロバイダにマッチします。 |
PlacesFeatures型はQFlags<PlacesFeature>の型定義である。これは、PlacesFeature 値の OR の組み合わせを格納します。
enum QGeoServiceProvider::RoutingFeature
flags QGeoServiceProvider::RoutingFeatures
ジオサービスプロバイダがサポートするルーティング機能について説明します。
定数 | 値 | 説明 |
---|---|---|
QGeoServiceProvider::NoRoutingFeatures | 0 | ルーティング機能はサポートされていません。 |
QGeoServiceProvider::OnlineRoutingFeature | (1<<0) | オンラインルーティングがサポートされています。 |
QGeoServiceProvider::OfflineRoutingFeature | (1<<1) | オフラインルーティングがサポートされています。 |
QGeoServiceProvider::LocalizedRoutingFeature | (1<<2) | ローカライズされた住所と指示でルートを返すことができます。 |
QGeoServiceProvider::RouteUpdatesFeature | (1<<3) | 現在位置に基づいて既存のルートを更新することができます。 |
QGeoServiceProvider::AlternativeRoutesFeature | (1<<4) | 代替ルートを返すことができます。 |
QGeoServiceProvider::ExcludeAreasRoutingFeature | (1<<5) | 返されたルートが越えてはならない地域を指定することができます。 |
QGeoServiceProvider::AnyRoutingFeatures | ~(0) | 任意のルーティング機能を提供するジオサービスプロバイダにマッチします。 |
RoutingFeatures 型はQFlags<RoutingFeature> の typedef です。RoutingFeaturesの値のORの組み合わせを格納する。
メンバ関数の説明
QGeoServiceProvider::QGeoServiceProvider(const QString &providerName, const QVariantMap ¶meters = QVariantMap(), bool allowExperimental = false)
提供されたparameters を使用して、バックエンドがproviderName という名前の QGeoServiceProvider を構築します。
複数のプラグインが同じproviderName を持つ場合、報告された providerVersion() が最も高いプラグインが使用されます。
allowExperimental が true の場合、experimental としてマークされたプラグインが使用されます。デフォルトでは、実験的なプラグインは考慮されません。
providerName に一致するプラグインがロードされなかった場合、error() とerrorString() でその理由の詳細が表示されます。
注意: parameters のリストがロードされるプロバイダ・プラグインに渡される前に、無関係なプロバイダ・プラグインとプラグイン固有のパラメータが共有されないように、リストがフィルタリングされます。プラグイン固有のパラメータ・キーの前には、プロバイダ名を付ける必要があります(例:here.app_id
)。
[virtual noexcept]
QGeoServiceProvider::~QGeoServiceProvider()
サービス・プロバイダ・オブジェクトを破棄します。
[static]
QStringList QGeoServiceProvider::availableServiceProviders()
QGeoServiceProvider コンストラクタで使用するために、利用可能なサービス・プロバイダの名前のリストを返します。
QGeoServiceProvider::Error QGeoServiceProvider::error() const
エラー・コード: このクラスが最後に実行した操作で発生したエラーを表すエラー・コードを返します。
QString QGeoServiceProvider::errorString() const
このクラスが最後に実行した操作で発生したエラーを記述した文字列を返します。
QGeoServiceProvider::Error QGeoServiceProvider::geocodingError() const
最後にジオコーディング・マネージャを作成しようとした際に発生したエラーを記述したエラー・コードを返します。
QString QGeoServiceProvider::geocodingErrorString() const
最後にジオコーディングマネージャを作成しようとした際に発生したエラーを表す文字列を返します。
QGeoServiceProvider::GeocodingFeatures QGeoServiceProvider::geocodingFeatures() const
ジオサービスプロバイダがサポートするジオコーディング機能を返す。
QGeoCodingManager *QGeoServiceProvider::geocodingManager() const
サービスプロバイダが提供するQGeoCodingManager を返す。
サービスプロバイダがジオコーディングサービスを提供していない場合、この関数はnullptr
を返す。
この関数は、初めて呼び出されたときにQGeoCodingManager インスタンスの構築を試みる。この試みが成功した場合、QGeoCodingManager はキャッシュされる。そうでない場合、この関数の各呼び出しは、構築に成功するまでQGeoCodingManager インスタンスの構築を試みる。
QGeoCodingManager はこのQGeoServiceProvider が所有するものであり、個別に削除してはならない。ユーザーは、QGeoServiceProvider を削除すると、このメソッドから返されるポインタが無効になると考えるべきである。
この関数が呼び出された後、error ()とerrorString ()は、QGeoCodingManager の構築中に発生したエラーを報告する。
QGeoServiceProvider::Error QGeoServiceProvider::mappingError() const
最後にマッピング・マネージャを作成しようとしたときに発生したエラーを示すエラー・コードを返します。
QString QGeoServiceProvider::mappingErrorString() const
最後にマッピング・マネージャを作成しようとしたときに発生したエラーを文字列で返します。
QGeoServiceProvider::MappingFeatures QGeoServiceProvider::mappingFeatures() const
ジオサービスプロバイダがサポートするマッピング機能を返します。
QGeoServiceProvider::Error QGeoServiceProvider::navigationError() const
エラーコード: 最後にナビゲーションマネージャーを作成しようとした際に発生した エラーを記述したエラーコードを返します。
QString QGeoServiceProvider::navigationErrorString() const
ナビゲーションマネージャーを最後に作成しようとした際に発生したエラーを記述した文字列を返します。
[since QtLocation 5.11]
QGeoServiceProvider::NavigationFeatures QGeoServiceProvider::navigationFeatures() const
ジオ・サービス・プロバイダがサポートするナビゲーション機能を返します。
この関数は QtLocation 5.11 で導入されました。
QPlaceManager *QGeoServiceProvider::placeManager() const
サービスプロバイダが提供するQPlaceManager を返します。
この関数は、初めて呼び出されたときにQPlaceManager インスタンスの作成を試みます。この試みが成功した場合、QPlaceManager はキャッシュされます。そうでない場合、この関数を呼び出すたびに、QPlace インスタンスの構築が成功するまで試行されます。
QGeoPlaceManager はこのQGeoServiceProvider によって所有され、個別に削除されるべきではありません。ユーザは、QGeoServiceProvider を削除すると、このメソッドによって返されるポインタは無効になると考えるべきである。
この関数が呼び出された後、error() およびerrorString() は、QPlaceManager の構築中に発生したエラーを報告します。
QGeoServiceProvider::Error QGeoServiceProvider::placesError() const
最後にプレース・マネージャを作成しようとしたときに発生したエラーを示すエラー・コードを返します。
QString QGeoServiceProvider::placesErrorString() const
プレイスマネージャを最後に作成しようとした際に発生したエラーを表す文字列を返す。
QGeoServiceProvider::PlacesFeatures QGeoServiceProvider::placesFeatures() const
places_features(プレイス機能): ジオサービスプロバイダがサポートするプレイス機能を返す。
QGeoServiceProvider::Error QGeoServiceProvider::routingError() const
エラーコード 【エラーコード】 ルーティングマネージャーを作成しようとして最後に発生したエラーを記述した 文字列を返します。
QString QGeoServiceProvider::routingErrorString() const
エラーコード ルーティングマネージャーを作成しようとした際に発生したエラーを文字列で返します。
QGeoServiceProvider::RoutingFeatures QGeoServiceProvider::routingFeatures() const
ジオサービスプロバイダーがサポートするルーティング機能を返します。
QGeoRoutingManager *QGeoServiceProvider::routingManager() const
サービスプロバイダが提供するQGeoRoutingManager を返します。
サービスプロバイダが地理ルーティングサービスを提供していない場合、この関数はnullptr
を返す。
この関数は、初めて呼び出されたときにQGeoRoutingManager インスタンスの構築を試みる。この試みが成功した場合、QGeoRoutingManager はキャッシュされる。そうでない場合、この関数の各呼び出しは、構築に成功するまでQGeoRoutingManager インスタンスの構築を試みる。
QGeoRoutingManager はこのQGeoServiceProvider が所有するものであり、個別に削除してはならない。ユーザーは、QGeoServiceProvider を削除すると、このメソッドから返されるポインタが無効になると考えるべきである。
この関数が呼び出された後、error() およびerrorString() は、QGeoRoutingManager の構築中に発生したエラーを報告する。
void QGeoServiceProvider::setAllowExperimental(bool allow)
このサービスプロバイダに適したプラグイン・ライブラリを探す際に、実験的なプラグインを考慮するかどうかをallow に設定します。
重要:これにより、このサービス・プロバイダーのインスタンスが保持している既存のマネージャーはすべて破棄されます。このメソッドを呼び出した後は、以前に取得したポインタを使用しないように注意してください。
void QGeoServiceProvider::setLocale(const QLocale &locale)
このサービスプロバイダが使用するロケールをlocale に設定します。 関連する機能(LocalizedMappingFeature などを参照)がある場合、プロバイダのデータの言語、単位、その他のロケール固有の属性を変更します。
void QGeoServiceProvider::setParameters(const QVariantMap ¶meters)
このサービスプロバイダの個々のマネージャクラスを構築するために使用されるパラメータをparameters に設定する。
parameters のリストがロードされるサービスプロバイダに渡される前に、無関係なサービスプロバイダとプロバイダ固有のパラメータが共有されないように、リストはフィルタリングされる。プロバイダ固有のパラメータ・キーには、プロバイダ名(例:here.app_id
)を先頭に付けなければならない。
重要:これにより、このサービスプロバイダのインスタンスが保持している既存のマネージャはすべて破棄されます。このメソッドを呼び出した後は、以前に取得したポインタを使用しないようにしてください。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。