com.nttdocomo.opt.device
クラス Pedometer

Object
  com.nttdocomo.opt.device.Pedometer

public class Pedometer

extends Object

携帯電話のネイティブ歩数計を定義します。 この歩数計クラスによってネイティブ歩数計から歩数情報を取得します。

i アプリケーションの起動有無に関わらず、ネイティブ歩数計は歩数情報を蓄積します。
待ち受け i アプリケーションからも利用可能です。

免責事項:

ネイティブ歩数計から取得される歩数情報は、必ずしも正確ではありません。 あくまでも目安として活用してください。

導入されたバージョン:

DoJa-5.1 (906i)

フィールドの概要

static int	ATTR_PEDOMETER_OFF 歩数計計測状態の属性値で、計測停止中（オフ）であることを表します(=0)。
static int	ATTR_PEDOMETER_ON 歩数計計測状態の属性値で、計測実施中（オン）であることを表します(=1)。
static int	DEV_PEDOMETER 歩数計の属性の種類で、計測状態を示します(=0)。

コンストラクタの概要

protected

Pedometer() アプリケーションが直接このコンストラクタを呼び出してオブジェクトを生成することはできません。

メソッドの概要

int	getAttribute(int attr) 歩数計の属性値を取得します。
int	getCount() ネイティブが現在保持している歩数情報の個数を取得します。
PedometerData[]	getData() ネイティブが保持している、全ての歩数計の履歴情報を取得します。
PedometerData[]	getData(int index, int articles) ネイティブが保持している、歩数計の履歴情報をインデックスと個数を指定して取得します。
static Pedometer	getPedometer() 歩数計オブジェクトを取得します。
PedometerData	getTodayData() ネイティブが保持している、今日の 0:00 からの歩数情報を取得します。
int	getTotalDistance() ネイティブが保持している歩数計の累積距離を取得します。
int	getTotalSteps() ネイティブが保持している歩数計の累積歩数を取得します。

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

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

フィールドの詳細

DEV_PEDOMETER

public static final int DEV_PEDOMETER

歩数計の属性の種類で、計測状態を示します(=0)。

関連項目:

getAttribute(int), 定数フィールド値

ATTR_PEDOMETER_OFF

public static final int ATTR_PEDOMETER_OFF

歩数計計測状態の属性値で、計測停止中（オフ）であることを表します(=0)。

計測停止中の場合、ネイティブ歩数計のカウントは行われません。

関連項目:

getAttribute(int), 定数フィールド値

ATTR_PEDOMETER_ON

public static final int ATTR_PEDOMETER_ON

歩数計計測状態の属性値で、計測実施中（オン）であることを表します(=1)。

関連項目:

getAttribute(int), 定数フィールド値

コンストラクタの詳細

Pedometer

protected Pedometer()

アプリケーションが直接このコンストラクタを呼び出してオブジェクトを生成することはできません。

メソッドの詳細

getPedometer

public static Pedometer getPedometer()

歩数計オブジェクトを取得します。 このメソッドを複数回呼び出した場合、常に同じオブジェクトへの参照が返されます。

戻り値:

歩数計オブジェクトを返します。

例外:

com.nttdocomo.lang.UnsupportedOperationException - 歩数計機能が未サポートの場合に発生します。

getAttribute

public int getAttribute(int attr)

歩数計の属性値を取得します。存在しない属性の種類が指定された場合は、 -1 を返します。

パラメータ:

attr - 歩数計の属性の種類を指定します。

戻り値:

指定された属性の値を返します。

getCount

public int getCount()

ネイティブが現在保持している歩数情報の個数を取得します。 歩数情報の個数とは、1 日分を 1 個としてカウントした時の個数です。

このメソッド呼び出し時点の歩数計の計測状態が ATTR_PEDOMETER_OFF である時、 個数として 0 を返します。
歩数計の計測状態が 1 日中 ATTR_PEDOMETER_OFF であった時、 歩数計測は行われません。その場合、その日の歩数情報は保持していないため、 個数にはカウントされません。

戻り値:

保持されている個数を返します。

getTotalSteps

public int getTotalSteps()

ネイティブが保持している歩数計の累積歩数を取得します。 当日分の情報を加算するため、このメソッドを複数回呼び出した場合、 呼び出す度に異なる値が返される可能性があります。

このメソッド呼び出し時点の歩数計の計測状態が ATTR_PEDOMETER_OFF である時、 累積歩数として 0 を返します。

戻り値:

歩数計の累積歩数を返します。

getTotalDistance

public int getTotalDistance()

ネイティブが保持している歩数計の累積距離を取得します。 当日分の情報を加算するため、このメソッドを複数回呼び出した場合、 呼び出す度に異なる値が返される可能性があります。

このメソッド呼び出し時点の歩数計の計測状態が ATTR_PEDOMETER_OFF である時、 累積距離として 0 を返します。

戻り値:

メートルに換算した歩数計の累積距離を返します。

getTodayData

public PedometerData getTodayData()

ネイティブが保持している、今日の 0:00 からの歩数情報を取得します。 ネイティブ歩数計の情報は常に更新されるため、このメソッドを複数回呼び出した場合、 呼び出す度に最新の歩数情報が設定された新しい歩数情報オブジェクトが生成され、 そのオブジェクトへの参照が返されます。

このメソッド呼び出し時点の歩数計の計測状態が ATTR_PEDOMETER_OFF である時、 例外 SecurityException が発生します。

戻り値:

歩数情報オブジェトを返します。

例外:

SecurityException - 歩数計の利用有無の設定機能などのネイティブのセキュリティ設定により、 歩数計の情報を取得できない場合に発生します。

getData

public PedometerData[] getData()

ネイティブが保持している、全ての歩数計の履歴情報を取得します。 呼び出された日（当日分も含め）から過去に向かってオブジェクトがソートされます。 返却されるオブジェクトの個数は、getCount() の個数と等しくなります。

このメソッドを複数回呼び出した場合、呼び出す度に新しい配列が生成され、 その配列への参照が返されます。 また、ネイティブ歩数計の情報は常に更新されるため、 当日分の歩数情報に関しては呼び出す度に最新の歩数情報が設定された新しいオブジェクトが生成され、 そのオブジェクトへの参照が配列に格納されます。

このメソッド呼び出し時点の歩数計の計測状態が ATTR_PEDOMETER_OFF である時、 例外 SecurityException が発生します。

戻り値:

歩数情報オブジェトの配列を返します。

例外:

SecurityException - 歩数計の利用有無の設定機能などのネイティブのセキュリティ設定により、 歩数計の情報を取得できない場合に発生します。

getData

public PedometerData[] getData(int index,
                               int articles)

ネイティブが保持している、歩数計の履歴情報をインデックスと個数を指定して取得します。 指定されたインデックス(これを含む)から過去に向かってオブジェクトがソートされます。 返却されるオブジェクトの個数は、指定された個数と等しくなります。
例）今日から過去 2 日分(今日と昨日)の歩数情報を取得する場合は getPedometerData(0, 2); を呼び出す。 (※前提としてネイティブが今日と昨日の履歴情報を保持していること)

このメソッドを複数回呼び出した場合、呼び出す度に新しい配列が生成され、 その配列への参照が返されます。 また、ネイティブ歩数計の情報は常に更新されるため、 当日分の歩数情報に関しては呼び出す度に最新の歩数情報が設定された新しいオブジェクトが生成され、 そのオブジェクトへの参照が配列に格納されます。

このメソッド呼び出し時点の歩数計の計測状態が ATTR_PEDOMETER_OFF である時、 例外 SecurityException が発生します。

パラメータ:

index - 最新(今日)から見て何個前(何日前)かを指定します。

articles - index から見て過去何個分(過去何日分)を取得するかを指定します。

戻り値:

歩数情報オブジェトの配列を返します。

例外:

SecurityException - 歩数計の利用有無の設定機能などのネイティブのセキュリティ設定により、歩数計の情報を取得できない場合に発生します。

IllegalArgumentException - 引数 index が 負の場合に発生します。

IllegalArgumentException - 引数 articles が 0 以下の場合に発生します。

IllegalArgumentException - 引数 index + articles が、 ネイティブが現在保持している歩数情報の個数を超過する場合に発生します。