SatelliteSource QML Type

SatelliteSourceクラスは、衛星情報を提供します。詳細...

Import Statement:	`import QtPositioning`
Since:	Qt 6.5

継承メンバを含む全メンバ一覧

プロパティ

active : bool
name : string
parameters : list<PluginParameter>
satellitesInUse : list<geoSatelliteInfo>
satellitesInView : list<geoSatelliteInfo>
sourceError : enumeration
updateInterval : int
valid : bool

メソッド

var backendProperty(string name)
bool setBackendProperty(string name, var value)
start()
stop()
update(int timeout)

詳細説明

SatelliteSourceクラスは、使用中の衛星や表示中の衛星に関する情報を提供する。このクラスはQGeoSatelliteInfoSource をQMLで表現したものです。

C++の同等クラスと同様に、このクラスは様々なプラグインをサポートしています。name プロパティを使用して、使用するプラグインの名前を指定し、必要に応じてPluginParameterを指定します。name プロパティが設定されていない場合は、デフォルトのプラグインが使用されます。利用可能なプラグインの詳細については、「Qt Positioning Plugins」を参照してください。

SatelliteSource の状態を確認するには、valid プロパティを使用します。

updateInterval プロパティを使用して、アプリケーションが衛星情報の更新を受信する頻度を指定します。start （）、stop （）、update （）メソッドを使用して、SatelliteSourceの動作を制御することができます。また、active プロパティを設定すると、start （）またはstop （）を呼び出すことと同じになります。

SatelliteSource がアクティブな場合、satellitesInView およびsatellitesInUse プロパティを使用して、衛星情報の更新を取得できます。

衛星情報の更新中にエラーが発生した場合は、sourceError プロパティを使用して、実際のエラー・コードを取得します。

使用例

次の例は、NMEAプラグインを使用して、衛星情報の更新を毎秒受信し、表示中の衛星数と使用中の衛星数をコンソールに出力する SatelliteSource を示しています。

SatelliteSource {
    id: source
    name: "nmea"
    active: true
    updateInterval: 1000
    PluginParameter { name: "nmea.source"; value: "serial:/dev/ttyACM0" }

    onSatellitesInUseChanged: {
        console.log("Satellites in use:", source.satellitesInUse.length)
    }
    onSatellitesInViewChanged: {
        console.log("Satellites in view:", source.satellitesInView.length)
    }
}

QGeoSatelliteInfoSource 、PluginParameter 、geoSatelliteInfoも参照してください。

プロパティの説明

active : bool

このプロパティは、衛星ソースがアクティブであるかどうかを示します。このプロパティをfalse に設定することは、stop を呼び出すことと同じであり、このプロパティをtrue に設定することは、start を呼び出すことと同じである。

start 、stop 、およびupdateも参照のこと。

name : string

このプロパティは、現在衛星情報を提供しているプラグインの一意の内部名を保持します。

このプロパティを設定すると、SatelliteSource が特定のバックエンド・プラグインを使用するようになります。name プロパティが変更された時点でSatelliteSource がアクティブな場合は、非アクティブになります。指定したバックエンドをロードできない場合、衛星ソースは無効になります。

name プロパティを変更すると、updateInterval プロパティも変更される場合があります。

parameters : list<PluginParameter> [default]

このプロパティは、プラグインパラメータのリストを保持します。

PluginParameterも参照。

satellitesInUse : list<geoSatelliteInfo> [read-only]

このプロパティは、現在使用中のサテライトのリストを保持する。これらは、「フィックス」を取得するために使用される衛星、つまり、現在位置を決定するために使用される衛星です。

satellitesInView : list<geoSatelliteInfo> [read-only]

このプロパティは、現在見えている衛星のリストを保持する。

sourceError : enumeration [read-only]

このプロパティは、バックエンド・データ・プロバイダで最後に発生したエラーを保持します。

SatelliteSource.AccessError - アプリケーションに必要な権限がないため、衛星バックエンドへの接続設定に失敗しました。
SatelliteSource.ClosedError：衛星バックエンドが接続をクローズしました。
SatelliteSource NoError.- エラーは発生していません。
SatelliteSource.UnknownSourceError - 不明なエラーが発生しました。
SatelliteSource.UpdateTimeoutError - 指定されたタイムアウト内に衛星情報を取得できませんでした。

updateInterval : int

このプロパティは、希望する更新間隔をミリ秒単位で保持する。

valid : bool [read-only]

このプロパティは、SatelliteSource オブジェクトがデータを提供する有効なバックエンドプラグインを取得している場合はtrue となり、そうでない場合はfalse となる。

アプリケーションは、このプロパティを確認し、衛星情報の提供がランタイムプラットフォーム上で利用可能かどうか、有効かどうかを判断し、それに応じて対応する必要がある。

メソッドの説明

var backendProperty(string name)

name というバックエンド固有のプロパティが存在する場合は、その値を返す。それ以外の場合（初期化されていないSatelliteSource で呼び出された場合を含む）、戻り値は無効である。

setBackendProperty()も参照 。

bool setBackendProperty(string name, var value)

name というバックエンド固有のプロパティをvalue に設定します。成功した場合は true を返し、そうでない場合は false を返します（初期化されていないSatelliteSource で呼び出された場合を含む）。

backendProperty()も参照 。

start()

サテライト・ソースからの更新を要求。設定されている場合はupdateInterval を使用し、設定されていない場合はデフォルトの間隔を使用する。利用可能なソースがない場合、このメソッドは動作しません。

stop 、update 、およびactiveも参照してください。

stop()

サテライト・ソースからの更新を停止します。利用可能なソースがない場合、またはソースがアクティブでない場合、このメソッドは機能しません。

start 、update 、およびactiveも参照してください。

update(int timeout = 0)

サテライト・ソースに単一の更新を要求する便利なメソッド。利用可能なソースがない場合、このメソッドには何の効果もありません。

サテライト・ソースがアクティブでない場合、更新を受信するのにかかる時間、または要求がタイムアウトするまでアクティブになります。リクエストのタイムアウト時間はプラグイン固有です。

timeout はミリ秒単位で指定する。timeout がゼロ (デフォルト値) の場合、ソースに適した妥当なタイムアウト時間がデフォルトになります。

start 、stop 、activeも参照してください。

本書に含まれる文書の著作権は、それぞれの所有者に帰属します。本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の商標です。その他すべての商標は、それぞれの所有者に帰属します。