com.docomo_um.module.location
クラス Location

java.lang.Object
  com.docomo_um.module.location.Location

public class Location
extends java.lang.Object

測位結果を表すクラスです。 このオブジェクトには、緯度・経度・高度・水平方向の精度といった位置情報、 ならびに測位時刻が格納されています。

フィールドの概要

static int	ACCURACY_COARSE 「測位レベル 1」に対応する精度の最悪値 [m] です。
static int	ACCURACY_FINE 「測位レベル 3」に対応する精度の最悪値 [m] です。
static int	ACCURACY_NORMAL 「測位レベル 2」に対応する精度の最悪値 [m] です。
static int	ACCURACY_UNKNOWN 精度が不明であることを表します。
static int	ALTITUDE_UNKNOWN 高度が不明であることを表します。

コンストラクタの概要

Location(Degree latitude, Degree longitude)
緯度・経度を指定して、このオブジェクトを生成します。

Location(Degree latitude, Degree longitude, int altitude, long timestamp, int accuracy)
緯度、経度、高度、測位時刻、水平方向の精度を指定して、 このオブジェクトを生成します。

メソッドの概要

int	getAccuracy() 水平方向の精度を [m] 単位で取得します。
int	getAltitude() 高度を取得します。
Degree	getLatitude() 緯度を取得します。
Degree	getLongitude() 経度を取得します。
long	getTimestamp() 測位した時刻をミリ秒単位で取得します。

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

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

フィールドの詳細

ACCURACY_COARSE

public static final int ACCURACY_COARSE

「測位レベル 1」に対応する精度の最悪値 [m] です。

関連項目:

getAccuracy(), 定数フィールド値

ACCURACY_NORMAL

public static final int ACCURACY_NORMAL

「測位レベル 2」に対応する精度の最悪値 [m] です。

関連項目:

getAccuracy(), 定数フィールド値

ACCURACY_FINE

public static final int ACCURACY_FINE

「測位レベル 3」に対応する精度の最悪値 [m] です。

関連項目:

getAccuracy(), 定数フィールド値

ACCURACY_UNKNOWN

public static final int ACCURACY_UNKNOWN

精度が不明であることを表します。

関連項目:

getAccuracy(), 定数フィールド値

ALTITUDE_UNKNOWN

public static final int ALTITUDE_UNKNOWN

高度が不明であることを表します。

関連項目:

getAltitude(), 定数フィールド値

コンストラクタの詳細

Location

public Location(Degree latitude,
                Degree longitude)

緯度・経度を指定して、このオブジェクトを生成します。

パラメータ:

latitude - 緯度を表す Degree オブジェクトを指定します。 表現する角度が、区間 [-90度, 90度] に含まれている必要があります。

longitude - 経度を表す Degree オブジェクトを指定します。 表現する角度が、区間 [-180度, 180度) に含まれている必要があります。

例外:

java.lang.NullPointerException - latitude または longitude にnullを指定した場合に発生します。

java.lang.IllegalArgumentException - latitude、longitudeの表現する角度が適切な区間に含まれていない場合に発生します。

Location

public Location(Degree latitude,
                Degree longitude,
                int altitude,
                long timestamp,
                int accuracy)

緯度、経度、高度、測位時刻、水平方向の精度を指定して、 このオブジェクトを生成します。

パラメータ:

latitude - 緯度を表す Degree オブジェクトを指定します。 表現する角度が、区間 [-90度, 90度] に含まれている必要があります。

longitude - 経度を表す Degree オブジェクトを指定します。 表現する角度が、区間 [-180度, 180度) に含まれている必要があります。

altitude - 高度 [m] を指定します。 不明な場合には ALTITUDE_UNKNOWN を指定します。

timestamp - 測位時刻を、 1970 年 1 月 1 日午前 0 時 (GMT) との差分で指定します。

accuracy - 水平方向の精度 [m] を指定します。 不明な場合は ACCURACY_UNKNOWN を、 1m 未満である場合には 0 を指定します。

例外:

java.lang.NullPointerException - latitude または longitude に null を指定した場合に発生します。

java.lang.IllegalArgumentException - accuracy に、-2 以下の値を指定した場合や、 latitude、longitudeの表現する角度が適切な区間に含まれていない場合に発生します。

メソッドの詳細

getAccuracy

public int getAccuracy()

水平方向の精度を [m] 単位で取得します。

精度情報が「測位レベル」としてしか取得できない通信モジュールの実装では、 ACCURACY_FINE、 ACCURACY_NORMAL、 ACCURACY_COARSE、 ACCURACY_UNKNOWN のいずれかしか返されません。 しかしながら、これらのフィールド値はそれぞれの 「測位レベル」における精度値(の最悪値)と一致しているため、 どちらの実装の場合でも同様な方法で精度の大小を比較することが可能です。 なお、コンストラクタによって明示的に水平方向の精度が指定されているインスタンスについては、 指定された水平方向の精度の値をそのまま返します。

戻り値:

水平方向の精度を返します。 単位は [m]です。 1m未満の場合には 0 が返ります。 精度が不明な場合には ACCURACY_UNKNOWN が返ります。

getAltitude

public int getAltitude()

高度を取得します。

高度の測位がサポートされているかどうかは通信モジュールの実装に依存します。 高度の測位がサポートされていない場合には、 Location インスタンスに対する getAltitude() 呼び出しは、 常に ALTITUDE_UNKNOWN を返します。 なお、コンストラクタ によって明示的に高度が指定されているインスタンスについては、 指定された高度の値をそのまま返します。

戻り値:

高度を返します。単位は [m] です。

getLatitude

public Degree getLatitude()

緯度を取得します。

戻り値:

緯度を表す Degree オブジェクトを返します。 値域は [-90度, 90度] です。

getLongitude

public Degree getLongitude()

経度を取得します。

戻り値:

経度を表す Degree オブジェクトを返します。 値域は [-180度, 180度) です。

getTimestamp

public long getTimestamp()

測位した時刻をミリ秒単位で取得します。

このオブジェクトが、LocationProvider.getLocation() により取得されたものである場合、 取得できる時刻は、 測位結果を受け取った時点の端末時刻であり、 ミニマムスペックでは、その時の精度は1秒です。

戻り値:

ミリ秒で測定した、 測位時刻と 1970 年 1 月 1 日午前 0 時 (GMT) との差を返します。