com.docomostar.system
クラス PhysicalActivityMonitor

Object
  上位を拡張 com.docomostar.system.PhysicalActivityMonitor

public final class PhysicalActivityMonitor
extends Object
 [iアプリオプションAPI]

身体活動量計を定義します。 ネイティブ身体活動量計から身体活動情報を取得する機能を提供します。

ネイティブ身体活動量計がオンになっていれば、 Star アプリケーションが起動しているかどうかにかかわらず、 ネイティブ身体活動量計は身体活動情報を蓄積します。

計測された身体活動情報は、 暦日(ネイティブ身体活動量計で管理しているタイムゾーンの00時00分00秒から1日間)単位で PhysicalActivityData インスタンスとして蓄積されており、 プログラマは getData(int, int) メソッドによって、蓄積された情報を取り出すことができます。

加えて、ネイティブ身体活動量計がオンになっていれば、 getMETs() メソッドを呼び出すことで メソッド呼び出し時点における運動強度を取得することができます。

導入されたバージョン:
Star-1.5

フィールドの概要
static int ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF
          ネイティブ身体活動量計の利用設定の状態の一つで、 ネイティブ身体活動量計がオフであることを表します(=0)。
static int ATTR_PHYSICAL_ACTIVITY_MONITOR_ON
          ネイティブ身体活動量計の利用設定の状態の一つで、 ネイティブ身体活動量計がオンであることを表します(=1)。
static int DEV_PHYSICAL_ACTIVITY_MONITOR
          ネイティブ身体活動量計の利用設定の状態を表します(=0)。
 
メソッドの概要
 int getAttribute(int attr)
          身体活動量計の属性値を取得します。
 int getCount()
           ネイティブ身体活動量計が現在保持している身体活動情報の個数を取得します。
 PhysicalActivityData[] getData(int index, int articles)
           ネイティブ身体活動量計が現在蓄積している、 身体活動情報の履歴を取得します。
 float getMETs()
           このメソッド呼び出し時点における運動強度 (METs: Metabolic Equivalents) を取得します。
static PhysicalActivityMonitor getPhysicalActivityMonitor()
           身体活動量計オブジェクトを取得します。
 boolean start()
           ネイティブ身体活動量計による身体活動情報の計測を開始します。
 boolean stop()
           ネイティブ身体活動量計による身体活動情報の計測を停止します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEV_PHYSICAL_ACTIVITY_MONITOR

public static final int DEV_PHYSICAL_ACTIVITY_MONITOR
ネイティブ身体活動量計の利用設定の状態を表します(=0)。 属性の取得のみ可能で、制御することはできません。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF

public static final int ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF
ネイティブ身体活動量計の利用設定の状態の一つで、 ネイティブ身体活動量計がオフであることを表します(=0)。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_PHYSICAL_ACTIVITY_MONITOR_ON

public static final int ATTR_PHYSICAL_ACTIVITY_MONITOR_ON
ネイティブ身体活動量計の利用設定の状態の一つで、 ネイティブ身体活動量計がオンであることを表します(=1)。

関連項目:
getAttribute(int), 定数フィールド値
メソッドの詳細

getPhysicalActivityMonitor

public static PhysicalActivityMonitor getPhysicalActivityMonitor()

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

ADF に AccessUserInfo キーの指定が必要です。

戻り値:
身体活動量計オブジェクトを返します。
例外:
UnsupportedOperationException -
身体活動量計機能が未サポートの場合に発生します。
DeviceException -
(NO_RESOURCES)
身体活動量計機能を利用するためのリソースを確保できない場合に発生します。
SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションが、 このメソッドを呼び出した場合に発生します。

getAttribute

public int getAttribute(int attr)
身体活動量計の属性値を取得します。 存在しない属性の種類が指定された場合は、 -1 を返します。

パラメータ:
attr - 身体活動量計の属性の種類を指定します。
戻り値:
指定された属性の値を返します。 DEV_PHYSICAL_ACTIVITY_MONITOR が指定された時のみ、意味のある値を返します。

getCount

public int getCount()

ネイティブ身体活動量計が現在保持している身体活動情報の個数を取得します。

身体活動情報の個数とは、1日分を1個としてカウントした時の個数です。 ただし、ネイティブ身体活動量計の利用設定の状態が、1日中 ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF であった日については、その日の身体計測情報は保持していないため、 個数にはカウントされません。

戻り値:
ネイティブ身体活動量計が現在保持している身体活動情報の個数を返します。
このメソッド呼び出し時点のネイティブ身体活動量計の利用設定の状態が ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF である時は0を返します。 ネイティブ独自のセキュリティ設定により、 ネイティブ身体活動量計にアクセスできない場合にも0を返します。

getData

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

ネイティブ身体活動量計が現在蓄積している、 身体活動情報の履歴を取得します。

身体活動情報の履歴は PhysicalActivityData インスタンスの配列として保持しており、 各要素は計測日の降順で(第0要素に一番最近のデータが格納される形で)ソートされています。 PhysicalActivityData インスタンス1つ分には 1日分(ネイティブ身体活動量計で管理しているタイムゾーンにおいて、 その日の00時00分00秒から1日間)の計測結果が格納されています。
例えば、ネイティブ身体活動量計が今日と昨日の身体活動情報を蓄積している場合、 getData(0, 2) を呼び出すことで、 0日前から最新2日分(今日と昨日)の身体活動情報を取得することができます。

なお、ネイティブ身体活動量計の利用設定の状態が1日中オフであった日については、 その日に対応する PhysicalActivityData インスタンスは存在していないことに注意してください。 したがって、上記の例で、仮に、ネイティブ身体活動量計の利用設定の状態が、 昨日1日間オフであった場合には、getData(0, 2) によって得られる配列には、 今日と一昨日の身体活動情報が格納されていることになります。

このメソッドを複数回呼び出した場合、呼び出す度に新しい配列が生成され、 その配列への参照が返されます。
また、ネイティブ身体活動量計の情報は常に更新されるため、 当日(0日前)の身体活動情報については、 このメソッド呼び出しの度に最新の情報を反映したインスタンスが生成され、 戻り値の配列に格納され、返されることになります。
当日分以外の身体活動情報インスタンスについて、 メソッド呼び出しの度に再生成されるのか、 同一インスタンスが再利用されるのかは機種依存です。

このメソッド呼び出し時点のネイティブ身体活動量計の利用設定の状態が ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF である場合は、例外 SecurityException が発生します。

パラメータ:
index - 内部で保持している身体活動情報の配列について、 取得開始位置を指定します。 すなわち、 最新(今日)から見て何個前から取得したいかを指定します。
articles - 内部で保持している身体活動情報の配列について、 取得する要素数を指定します。 第 index 要素から見て過去何個分を取得するかを指定します。
戻り値:
内部で保持している身体活動情報の配列から、 第 index 要素から第 (index + articles - 1) 要素までの身体活動情報インスタンスが格納された配列を返します。
例外:
SecurityException -
ネイティブ独自のセキュリティ設定により、 ネイティブ身体活動量計の情報を取得できない場合に発生します。 ネイティブ身体活動量計の利用設定の状態がオフである場合も含みます。
IllegalArgumentException -
引数 index が 負の場合に発生します。
IllegalArgumentException -
引数 articles が0以下の場合に発生します。
IllegalArgumentException -
引数 index + articles が、 ネイティブ身体活動量計が現在保持している身体活動情報の個数を超過する場合に発生します。
DeviceException -
(RACE_CONDITION)
何らかの競合により、 ネイティブ身体活動量計へのアクセスに失敗した場合に発生します。

getMETs

public float getMETs()

このメソッド呼び出し時点における運動強度 (METs: Metabolic Equivalents) を取得します。
運動強度は身体運動時の代謝量が、 安静時の何倍に相当するのかを示す尺度です。 1.0 METs が安静時の代謝量を示します。

測定値が更新される周期は機種依存です。 このメソッド呼び出し時点のネイティブ身体活動量計の利用設定の状態が ATTR_PHYSICAL_ACTIVITY_MONITOR_OFF である場合は、 例外 SecurityException が発生します。

戻り値:
運動強度 [METs] を返します。
例外:
SecurityException -
ネイティブ独自のセキュリティ設定により、 ネイティブ身体活動量計の情報を取得できない場合に発生します。 ネイティブ身体活動量計の利用設定の状態がオフである場合も含みます。
DeviceException -
(RACE_CONDITION)
何らかの競合により、 ネイティブ身体活動量計へのアクセスに失敗した場合に発生します。

start

public boolean start()

ネイティブ身体活動量計による身体活動情報の計測を開始します。

このメソッドが呼び出されると、この Star アプリはサスペンドしユーザ確認のダイアログが表示されます。
ユーザ操作によって許可された場合、ネイティブ身体活動量計は計測を開始し、 このメソッドの戻り値として true を返します。 キャンセルされた場合は、計測は開始されず、戻り値として false を返します。
ユーザ操作によりダイアログが閉じられると、この Star アプリはレジュームします。

計測状態が計測実施中の状態でこのメソッドを呼び出した場合、 ユーザ確認のダイアログは表示されず、戻り値として true を返します。 ネイティブ身体活動量計の現在の計測状態は、getAttribute(DEV_PHYSICAL_ACTIVITY_MONITOR) により取得することができます。

このメソッドによって制御したネイティブ身体活動量計の計測状態は、Star アプリが終了した後も継続されます。

戻り値:
計測を開始することに成功した場合 true を、失敗した場合 false を返します。
導入されたバージョン:
Star-2.0
例外:
IllegalStateException -
ミニアプリ実行時の Focused または Unfocused 状態で呼び出された場合に発生します。
SecurityException -
ネイティブ独自のセキュリティ設定により、計測を開始できない場合に発生します。

stop

public boolean stop()

ネイティブ身体活動量計による身体活動情報の計測を停止します。

このメソッドが呼び出されると、この Star アプリはサスペンドしユーザ確認のダイアログが表示されます。
ユーザ操作によって許可された場合、ネイティブ身体活動量計は計測を停止し、 このメソッドの戻り値として true を返します。 キャンセルされた場合は、計測は停止されず、戻り値として false を返します。
ユーザ操作によりダイアログが閉じられると、この Star アプリはレジュームします。

計測状態が計測停止中の状態でこのメソッドを呼び出した場合、 ユーザ確認のダイアログは表示されず、戻り値として true を返します。 ネイティブ身体活動量計の現在の計測状態は、getAttribute(DEV_PHYSICAL_ACTIVITY_MONITOR) により取得することができます。

このメソッドによって制御したネイティブ身体活動量計の計測状態は、Star アプリが終了した後も継続されます。

戻り値:
計測を停止することに成功した場合 true を、失敗した場合 false を返します。
導入されたバージョン:
Star-2.0
例外:
IllegalStateException -
ミニアプリ実行時の Focused または Unfocused 状態で呼び出された場合に発生します。
SecurityException -
ネイティブ独自のセキュリティ設定により、計測を停止できない場合に発生します。


NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。