com.docomostar.device.location
クラス AccelerationData

Object
  com.docomostar.device.location.AccelerationData

public class AccelerationData
extends Object

[iアプリオプションAPI]

加速度センサ機能の加速度取得機能により取得したデータを定義します。

このクラスでは、次のデータを取得することができます。

• X/Y/Z軸方向の加速度値
• ロール角、ピッチ角
• メインスクリーンの縦横の向き(オプション)

実装によっては、メインスクリーンの縦横の向きをサポートしていない場合があります。

このオブジェクトの内部には、計測データを配列として保持しています。 このクラスのメソッドにおいて、戻り値として配列を返す場合、 オブジェクト内部で保持する配列への参照を返します。

計測データの各値を更新するためには、AccelerationSensor.getCurrentData(), AccelerationSensor.getData(), AccelerationSensor.peekLatestData() を呼び出す必要があります。

このオブジェクトの内部で保持している配列の長さは、 size() で取得できる計測データ数より長い場合があります。 その場合、配列の ( size() - 1 ) 番目までの要素には有効な計測値が格納されていますが、 size() 番目以降の要素には不定値が格納されています。 なお、 size() で取得できる計測データ数が 0 の場合は、 配列の全要素に不定値が格納されています。

導入されたバージョン:

Star-1.0

関連項目:

AccelerationSensor

メソッドの概要

int[]	getAccelerationX() X軸方向の加速度値を取得します。
int[]	getAccelerationY() Y軸方向の加速度値を取得します。
int[]	getAccelerationZ() Z軸方向の加速度値を取得します。
int[]	getPitch() 端末の傾き(ピッチ角)を取得します。
int[]	getRoll() 端末の傾き(ロール角)を取得します。
int[]	getScreenOrientation() メインスクリーンの縦横の向きを取得します。
int	size() このオブジェクトに含まれている計測データ数を取得します。

クラス Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

size

public int size()

このオブジェクトに含まれている計測データ数を取得します。

このオブジェクトに計測データが含まれていない場合は0を返します。

戻り値:

計測データ数を返します。

getAccelerationX

public int[] getAccelerationX()

X軸方向の加速度値を取得します。

戻り値:

X軸方向の加速度値を返します。単位はmg(ミリジー) (g=9.8m/s2)です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException -
[Star-1.3 まで] 実装がこの方向の加速度値をサポートしていない場合に発生します。

getAccelerationY

public int[] getAccelerationY()

Y軸方向の加速度値を取得します。

戻り値:

Y軸方向の加速度値を返します。単位はmg(ミリジー) (g=9.8m/s2)です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException -
[Star-1.3 まで] 実装がこの方向の加速度値をサポートしていない場合に発生します。

getAccelerationZ

public int[] getAccelerationZ()

Z軸方向の加速度値を取得します。

戻り値:

Z軸方向の加速度値を返します。単位はmg(ミリジー) (g=9.8m/s2)です。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException -
[Star-1.3 まで] 実装がこの方向の加速度値をサポートしていない場合に発生します。

getRoll

public int[] getRoll()

端末の傾き(ロール角)を取得します。

[Star-1.3 まで]
取得できる傾きの幅は[-180度, 180度) または [-90度, 90度]です。

[Star-1.5 以降]
取得できる傾きの幅は[-180度, 180度) です。

戻り値:

端末の傾き（ロール角)を返します。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException -
[Star-1.3 まで] 実装がロール角の取得 をサポートしていない場合に発生します。

getPitch

public int[] getPitch()

端末の傾き(ピッチ角)を取得します。

[Star-1.3 まで]
取得できる傾きの幅は [-180度, 180度) または [-90度, 90度] です。

[Star-1.5 以降]
取得できる傾きの幅は [-180度, 180度) です。

戻り値:

端末の傾き（ピッチ角)を返します。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException -
[Star-1.3 まで] 実装がピッチ角の取得 をサポートしていない場合に発生します。

getScreenOrientation

public int[] getScreenOrientation()

メインスクリーンの縦横の向きを取得します。

向きが判定できる場合、 Z 軸を中心として時計回りに、0, 90, 180, 270を返します。 向きが判定できない場合、 例えば X 軸・Y軸方向の加速度が共に 0 に近い場合、 -1 を返します。

戻り値:

メインスクリーンの縦横の向きを返します。 古い測定データから順に配列の先頭から格納されます。 返される配列は、このオブジェクトが内部で保持している配列への参照です。

例外:

UnsupportedOperationException -
実装がメインスクリーンの向きの取得をサポート していない場合に発生します。