QSensor Class

プロパティのドキュメント

active : bool

このプロパティは、センサーがアクティブであるかどうかを示す値を保持します。

センサーがアクティブ（値を返している）場合は true になります。それ以外の場合は false になります。

なお、この値を true に設定しても即座に反映されるわけではありません。代わりに、イベントループが実行された時点でセンサーが起動されます。

アクセス関数：

通知シグナル:

alwaysOn : bool

このプロパティは、画面がオフの状態でセンサーを稼働し続けるかどうかを示す値を保持します。

一部のプラットフォームでは、画面がオフになるとセンサーを一時停止するという仕様があります。このプロパティを true に設定すると、センサーが引き続き動作するようになります。

アクセス関数:

通知シグナル：

[read-only] availableDataRates : qrangelist

このプロパティには、センサーがサポートするデータレートが格納されています。

これは、センサーが対応するデータレートのリストです。単位はヘルツです。

リスト内の項目は、離散的なレート、または連続的なレートの範囲を表すことができます。離散的なレートは、両方の値が同じであることで示されます。

なお、すべてのセンサーに動作レートがあるわけではないため、この情報は必須ではありません。そのような場合、リストは空になります。

アクセス関数：

関連項目: QSensor::dataRate およびqrangelist 。

axesOrientationMode : AxesOrientationMode

このプロパティは、画面の向きが値の表示にどのように影響するかを決定するモードを保持します。

デフォルトモードである「FixedOrientation 」に設定すると、測定値には自動回転が適用されません。これは、QSensor::AxesOrientation 機能をサポートしていないバックエンドで利用可能な唯一のモードです。

AutomaticOrientation に設定すると、画面の向きが変わったときに読み取り値が自動的に回転します。事実上、画面の向きは相殺されます。

例として、デバイスが180度回転し、その結果、画面の向きも本来の向きから180度回転したと仮定します。 軸の自動方向調整が有効でない場合、測定値は変化することになります。X 値と Y 値の両方が負の値となり、アプリケーション開発者はアプリケーションコード内で手動でこの負の値を相殺する必要があります。軸の自動方向調整はこれを自動的に行います。このモードでは、X 値と Y 値はデフォルトの画面向きの場合と同じになります。

この軸の自動回転は、いくつかのユースケースで便利です。例えば、加速度センサーの X 軸の値を見て、表面がどれだけ水平であるかを測定する水準器アプリケーションなどです。 デバイスや画面の向きが90度変化しても、アプリケーション開発者は何も変更する必要がなく、デバイスが回転していてもX軸の値を使い続けることができます。軸の自動回転機能がない場合、アプリケーション開発者は代わりにY軸の値を確認する必要があり、画面の向きに応じて異なる軸から値を読み取るコードをアプリケーションに追加しなければなりません。

UserOrientation モードはAutomaticOrientation と非常に似ていますが、画面の向きが自動的に決定されるのではなく、手動で制御される点が異なります。その場合、userOrientation プロパティの角度が、読み取り値の回転に使用されます。

読み取り値の回転は画面の向きに基づいているため、Z軸は画面に対して垂直であることから、Z値は決して変化しません。画面の向きは90度単位で変化するため、読み取り値の回転も90度単位で行われます。

このプロパティは、向き変更可能なセンサーでのみ使用されます。

アクセス関数：

通知信号：

bufferSize : int

このプロパティは、バッファのサイズを保持します。デフォルトでは、バッファサイズは 1 であり、これはバッファリングが行われないことを意味します。最大バッファサイズが 1 の場合、そのセンサーではバッファリングはサポートされていません。

bufferSizeをmaxBufferSize より大きく設定すると、maxBufferSize が使用されます。

bufferSizeが1より大きい場合、バッファリングが有効になります。センサーは要求された数のサンプルを収集し、それらを一度にアプリケーションに送信します。これらは変更された測定値のバーストとしてアプリケーションに送信されるため、アプリケーションが各測定値を直ちに処理するか、値を別の場所に保存することが特に重要です。

バッファリングが進行中にstop()が呼び出された場合、バッファに蓄積された一部のデータはアプリケーションに送信されません。

バッファリングオプションを指定してセンサーを起動した場合、その時点から値の収集が開始されます。利用可能な既存のバッファは存在しません。

一部のバックエンドでは、バッファの有効化または無効化のみをサポートしており、サイズを制御することはできません。この場合、バッファリングがサポートされていても、maxBufferSize およびefficientBufferSize プロパティはまったく設定されない可能性があります。bufferSize プロパティを 1 より大きい値に設定すると、バッファリングが有効になります。 センサーの起動後、bufferSizeプロパティはバックエンドによって実際の値に設定されます。

アクセス関数：

通知シグナル:

QSensor::maxBufferSize およびQSensor::efficientBufferSizeも参照してください 。

[read-only] busy : bool

このプロパティは、センサーがビジー状態であるかどうかを示す値を保持します。

システム上にセンサーが存在していても、使用できない場合があります。センサーがビジー状態の場合、この関数は true を返します。その場合、start() を実行することはできません。

なお、この関数は、自身がそのセンサーを使用している場合には true を返さず、別のプロセスがそのセンサーを使用している場合にのみ true を返します。

アクセス関数：

通知シグナル:

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

[read-only] connectedToBackend : bool

このプロパティは、センサーがバックエンドに接続されているかどうかを示す値を保持しています。

バックエンドに接続されていないセンサーは、有用な処理を行うことができません。

connectToBackend() メソッドを呼び出すと、センサーを直ちにバックエンドに接続させることができます。start() を呼び出すと、このメソッドは自動的に呼び出されるため、センサーのプロパティにアクセスする必要がある場合（つまり、センサーを使用する前にそのメタデータをポーリングする場合など）にのみ、この操作を行う必要があります。

アクセス関数：

[read-only] currentOrientation : int

このプロパティは、測定値を回転させる際に使用される現在の向きを保持します。

これは画面の向きとは異なる場合があります。たとえば、「FixedOrientation 」モードでは、測定値は回転されないため、このプロパティの値は 0 になります。

「UserOrientation 」モードでは、userOrientation プロパティに基づいて測定値が回転されるため、このプロパティはuserOrientation プロパティと同じ値になります。

AutomaticOrientation モードでは、測定値は画面の向きに基づいて回転されるため、このプロパティは現在の画面の向きと同じ値になります。

このプロパティはバックエンドによって設定され、向きを検知可能なセンサーでのみ有効です。

アクセス関数:

通知信号：

dataRate : int

このプロパティには、センサーを動作させるべきデータレートが格納されています。

単位はヘルツです。

データレートとは、センサーが変化を検出できる最大周波数のことです。

このプロパティの設定は移植性がなく、他のアプリケーションとの競合を引き起こす可能性があります。複数のアプリケーションがデータレートを要求する場合のポリシーについては、センサーのバックエンドおよびプラットフォームのドキュメントを確認してください。

デフォルト値 (0) は、アプリがデータレートを問わないことを意味します。プラットフォームは 1 秒間に数百回更新を行う場合があるため、アプリケーションでは、タイマーベースの現在の値のポーリングを使用するか、値を処理するコードが非常に高速に実行されるようにする必要があります。

センサーは実行中にこの値の変更を認識しない可能性があるため、start() を呼び出す前にこの設定を行う必要があります。

なお、プラットフォームが現在使用しているデータレートを判別する仕組みは存在しません。

アクセス関数：

通知シグナル：

QSensor::availableDataRatesも参照してください 。

[read-only] description : QString

このプロパティには、センサーに関する説明文字列が格納されます。

アクセス関数：

[read-only] efficientBufferSize : int

このプロパティは、最も効率的なバッファサイズを保持します。通常、この値は 1 です（つまり、特に効率的なサイズはないことを意味します）。一部のセンサドライバには FIFO バッファが搭載されており、FIFO のサイズ分の読み取り値を一度に送信する方が効率的です。

アクセス関数：

通知信号：

関連項目: QSensor::bufferSize およびQSensor::maxBufferSize 。

[read-only] error : int

このプロパティには、センサーに最後に設定されたエラーコードが格納されます。

なお、エラーコードはセンサーごとに異なります。

アクセス関数：

通知信号：

identifier : QByteArray

このプロパティには、センサーのバックエンド識別子が格納されます。

なお、この識別子は、センサーがバックエンドに接続されると自動的に設定されます。特定のバックエンドに接続したい場合は、connectToBackend() を呼び出す前に setIdentifier() を呼び出す必要があります。

アクセス関数：

Notifierシグナル：

[read-only] maxBufferSize : int

このプロパティは、最大バッファサイズを保持します。

なお、この値が 1 の場合、センサーはいかなる形式のバッファリングもサポートしていないことに注意してください。その場合、isFeatureSupported （QSensor::Buffering ）も false を返します。

アクセス関数:

通知シグナル：

QSensor::bufferSize およびQSensor::efficientBufferSizeも参照してください 。

outputRange : int

このプロパティには、センサーが使用している出力範囲が格納されています。

この値は、使用するQSensor::outputRanges リスト内のインデックスを表します。

このプロパティの設定は移植性がなく、他のアプリケーションとの競合を引き起こす可能性があります。複数のアプリケーションが出力範囲を要求する場合のポリシーについては、センサーのバックエンドおよびプラットフォームのドキュメントを確認してください。

デフォルト値 (-1) は、アプリが出力範囲を問わないことを意味します。

プラットフォームが現在使用している出力範囲を特定するメカニズムはないことに注意してください。

アクセス関数:

「QSensor::outputRanges」も参照してください 。

[read-only] outputRanges : qoutputrangelist

このプロパティには、センサーがサポートする出力範囲のリストが格納されています。

1つのセンサーに複数の出力範囲が設定されている場合があります。通常、これは精度を犠牲にする代わりに、より広い測定範囲を確保するために行われます。

なお、この情報は必須ではありません。通常、この情報は出力範囲が選択可能なセンサー（一般的な加速度センサーなど）でのみ利用可能です。

アクセス関数:

関連項目: QSensor::outputRange およびqoutputrangelist 。

[read-only] reading : QSensorReading*

このプロパティは、読み取りクラスを保持します。

readingクラスは、センサーの測定値へのアクセスを提供します。readingオブジェクトは、受信された最新のセンサー測定値を一時的に保持するキャッシュであるため、アプリケーションは測定値を直ちに処理するか、後で処理するためにどこかに値を保存する必要があります。

なお、センサーバックエンドがバックエンドに接続されるまでは、このメソッドは 0 を返します。

また、start() が呼び出されても、読み取り値はすぐには利用できない点にも注意してください。アプリケーションは、readingChanged() シグナルが発信されるまで待機する必要があります。

アクセス関数：

通知シグナル：

isConnectedToBackend() およびstart()も参照してください 。

skipDuplicates : bool

重複する測定値を省略するかどうかを示します。

重複スキップが有効になっている場合、同じ値または非常に類似した値の連続した測定値は省略されます。これにより、利用可能なセンサー測定値の数が減るため、処理負荷を軽減できます。その結果、測定値の到着間隔は不規則になります。

重複スキップは、値が完全に同一の測定値だけでなく、非常に類似した測定値に対しても有効になります。これは、デバイスが動いていなくても各センサーには多少のジッターが生じるためです。

このプロパティのサポートはバックエンドによって異なります。isFeatureSupported() を使用して、現在のプラットフォームでサポートされているかどうかを確認してください。

重複スキップはデフォルトで無効になっています。

重複スキップはセンサーの起動時に有効になります。センサーがアクティブな状態でこのプロパティを変更しても、即座には反映されません。

アクセス関数：

通知シグナル：

[read-only] type : const QByteArray

このプロパティには、センサーの型が格納されます。

アクセス関数：

userOrientation : int

このプロパティは、UserOrientation モードで読み取り値を回転させる際に使用される角度を保持します。

axesOrientationMode プロパティがUserOrientation に設定されている場合、読み取り値を回転させる角度はこのプロパティから取得されます。その他のモードでは、このプロパティは効果を持ちません。

デフォルト値は 0 です。有効な値は 0、90、180、270 のみです。これらは、画面の向きとして可能な角度のみだからです。

このプロパティは、向きを変更可能なセンサーでのみ有効です。

アクセス関数：

通知シグナル：

QSensor *magnetometer = new QSensor(QMagnetometer::sensorType, this);

QMagnetometer *magnetometer = new QMagnetometer(this);

sensor.start();
if (sensor.isBusy()) {
    // need to wait for busyChanged signal and try again
}

sensor->start();
sensor->reading()->x(); // no data available

    connect(sensor, SIGNAL(readingChanged()), this, SLOT(checkReading()));
    sensor->start();
}
void MyClass::checkReading() {
    sensor->reading()->x();

typedef QList<qoutputrange> qoutputrangelist;

typedef QPair<int,int> qrange;

typedef QList<qrange> qrangelist;