com.docomostar.opt.device
クラス PhysicalActivityData

Object
  com.docomostar.opt.device.PhysicalActivityData

public class PhysicalActivityData

extends Object

身体活動情報を表すクラスです。 このオブジェクトは、 1日分の活動量をエクササイズという単位(後述)で保持しています。 ここで言う「1日分」とは、日本時間で、当該日付の 00:00:00(00時00分00秒)から24:00:00の時間帯を指し、 00:00:00の瞬間は含み、24:00:00の瞬間は含まないものとします。

内部的には、活動量は、00:00:00から getInterval() 秒ごとのエクササイズ値を配列(以降では、 この配列のことを内部配列と呼びます)として保持しています。 具体的には、配列の第 n 要素には、 (t * n) 秒後から (t * (n + 1)) 秒後までの活動量(エクササイズ)が格納されています。 ここで、t は getInterval() の戻り値とし、 各時間帯の右端 ((t * (n + 1))秒後の瞬間) は含まないものとします。
例えば、t = 3600(1時間)である場合は、以下のようになります。

• 内部配列の第0要素には、 時刻00:00:00から01:00:00まで(01:00:00は含まない)の活動量が格納されています。
• 内部配列の第1要素には、 時刻01:00:00から02:00:00まで(02:00:00は含まない)の活動量が格納されています。
• ...
• 内部配列の第23要素には、 時刻23:00:00から24:00:00まで(24:00:00は含まない)の活動量が格納されています。

以降では、内部配列の第 n 要素における、 活動量の計測対象となっている時間帯のことを、 単純に、内部配列の第 n 要素における計測対象時間帯 と呼ぶことにします。上記の例では、 内部配列の第1要素における計測対象時間帯は 「01:00:00から02:00:00まで(02:00:00は含まない)」 となります。

また、ネイティブ身体活動量計の利用設定がオフである間の活動量は0であるとみなされます。

このクラスのインスタンスが保持している身体活動情報は、 getExercise メソッドにより、 身体活動の量を表す「エクササイズ」と呼ばれる単位で取得することができます。 エクササイズとは、METs (運動強度)に運動時間 [h] を掛けたものです。 すなわち、1.0 METs の運動を1.0時間継続した場合の身体活動量が1.0エクササイズ となります。

導入されたバージョン:

Star-1.1

メソッドの概要

java.util.Date	getDate() このオブジェクトの持つ日付 (JST) の Date オブジェクトを取得します。
float	getExercise() このオブジェクトが保持しているエクササイズの総計(1日分)を取得します。
float	getExercise(java.util.Date time, int range) 引数で指定した時間帯における、 エクササイズの合計を取得します。
float[]	getExercise(int cycle) このオブジェクトが保持しているエクササイズ(1日分)について、 00:00:00から指定された周期 [秒] ごとのエクササイズを配列として取得します。
int	getInterval() このオブジェクトが保持しているエクササイズの周期(時間間隔) [秒] を取得します。

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

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

メソッドの詳細

getDate

public java.util.Date getDate()

このオブジェクトの持つ日付 (JST) の Date オブジェクトを取得します。 この Date オブジェクトの時間情報は 00:00:00 となります。

このオブジェクトが保持している身体活動情報の日付を JST (日本標準時) の時刻と解釈して Date オブジェクトを生成します。 なお、Date オブジェクトの toString() は、デフォルトタイムゾーンの時刻を返すことに注意してください。

このメソッドを複数回呼び出した場合、 呼び出す度に新しい Date インスタンスが生成され、 そのインスタンスへの参照が返されます。

戻り値:

このオブジェクトの持つ日付を表す Date オブジェクトを返します。

getExercise

public float getExercise()

このオブジェクトが保持しているエクササイズの総計(1日分)を取得します。 エクササイズの定義については、 このクラスの説明を参照してください。

戻り値:

このオブジェクトが持っているエクササイズの総計を返します。

getExercise

public float getExercise(java.util.Date time,
                         int range)

引数で指定した時間帯における、 エクササイズの合計を取得します。
エクササイズの合計の、正確な計算方法は以下の通りです。

1. 内部配列の各要素(エクササイズ値)のうち、 その計測対象時間帯全体が、 引数で指定した時間帯に含まれるものを列挙します。 その結果、 内部配列の第 b 要素から 第 e 要素までが列挙されたこととします。
2. 内部配列の第 (b - 1) 要素が存在する場合、 その要素の計測対象時間帯が、一部だけでも、 引数で指定した時間帯に含まれるかどうかを調べます。 含まれる場合、その要素の値(エクササイズ値)を Eb とします。 含まれない場合や、当該要素が存在しない場合は、Eb は0とします。
3. 以下の総和を取ったものを、このメソッドの戻り値とします。
   • 内部配列の第 b 要素から 第 e 要素までの値(エクササイズ値)の総和
   • Eb の値

ここで、引数で指定した時間帯は、 左端(時刻 time)を含み、 右端(time の range 秒後の時刻)は含まないものとします。
エクササイズの定義については、 このクラスの説明を参照してください。

引数で指定する時間帯は、日本時間で日付をまたがってはいけません。 そのような時間帯を指定された場合は、 日付をまたがる直前までの時間帯が指定されたものとみなされます。

指定された時間帯において、 ネイティブ身体活動量計の利用設定の状態がずっとオフであった場合には、このメソッドは0.0を返します。

パラメータ:

time - エクササイズの合計を開始する時刻を指定します。 指定された Date オブジェクトは日本時間で解釈された上で、 日付部分は無視されます。

range - エクササイズの合計を行う範囲を秒単位で指定します。 getInterval() より小さい値を指定することはできません。

戻り値:

時刻 time からはじまり、その range 秒後までの時間帯(ただし 時刻 time の range 秒後の瞬間は含みません)における、 エクササイズの合計を返します。

例外:

IllegalArgumentException -
引数 range が getInterval() よりも小さい場合に発生します。

getExercise

public float[] getExercise(int cycle)

このオブジェクトが保持しているエクササイズ(1日分)について、 00:00:00から指定された周期 [秒] ごとのエクササイズを配列として取得します。
ある一定周期ごとのエクササイズの推移を調べたい時に便利です。 例えば、1時間周期のグラフを作成したい場合には getExercise(3600) を呼び出してください。

正確には、戻り値として得られる配列の 第 n 要素には下記の値が格納されています。

getExercise(new Date(getDate().getTime() + cycle * 1000 * n), cycle)

上記定義からも分かるように、引数 cycle には、getInterval() の倍数を指定するようにしてください。 そうでない値を cycle に指定した場合には、 配列の各要素に格納されるエクササイズの値が不均一なってしまうので注意が必要です。

パラメータ:

cycle - 周期を秒単位で指定します。 getInterval() よりも小さい値を指定することはできません。

戻り値:

指定された周期ごとのエクササイズの配列を返します。 このメソッドを呼び出す度に新しく生成した配列を返します。

例外:

IllegalArgumentException -
引数 cycle が getInterval() よりも小さい場合に発生します。

getInterval

public int getInterval()

このオブジェクトが保持しているエクササイズの周期(時間間隔) [秒] を取得します。
例えば、(1日分のエクササイズを)1分周期で保持している場合には、 60 [秒]が返ります。 1時間周期の場合には3600 [秒]が返ります。

86400 [秒](1日間の秒数)を、このメソッドの戻り値で割り算することで、 内部配列の要素数がわかります。

周期は実装によって異なります。 また、 このオブジェクトが何日前のデータを保持しているかによっても周期が異なる可能性があります。
たとえば、今日を含めて2日間は1分周期で情報を保持しているが、 3日前以前については 1日の合計値のみ保持する実装の場合は、 今日を含めた2日間は60が返され、 3日前以前については86400(1日間の秒数)が返されることになります。

戻り値:

このオブジェクトが保持しているエクササイズの周期(時間間隔)を、 秒単位で返します。