com.docomostar.opt.system.formanalyzer
クラス FormAnalyzer

Object
  com.docomostar.opt.system.formanalyzer.FormAnalyzer

public final class FormAnalyzer
extends Object

フォーム分析機能を定義します。 ネイティブのフォーム分析機能が歩行時などのフォームを分析した結果を、各種計測データとして取得することができます。

フォーム分析機能は start(boolean)、および stop() メソッドを呼び出すことにより、ネイティブのフォーム分析機能を制御することができます。 ネイティブのフォーム分析機能は start(boolean) により開始されてから、stop() などで停止されるまでの間、 計測データを蓄積します。

ネイティブに蓄積された計測データは getData(Calendar, Calendar) により取得することができます。

導入されたバージョン:

Star-1.5

フィールドの概要

static int	MODE_RUNNING 診断モードの１つで、ランニングフォーム診断モードを表します(=1)。
static int	MODE_WALKING 診断モードの１つで、ウォーキングフォーム診断モードを表します(=0)。

メソッドの概要

void	disposeData() ネイティブのフォーム分析機能が保持している計測データを削除します。
static int[]	getAvailableMode() フォーム分析機能に設定可能な診断モードを取得します。
FormData	getData(java.util.Calendar start, java.util.Calendar end) ネイティブのフォーム分析機能が保持している計測データを取得します。
static FormAnalyzer	getFormAnalyzer(int mode) 指定した診断モードのフォーム分析機能のインスタンスを返します。
int	getMode() このインスタンスの診断モードを返します。
void	start(boolean continuance) フォーム分析を開始します。
void	stop() フォーム分析を停止します。

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

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

フィールドの詳細

MODE_WALKING

public static final int MODE_WALKING

診断モードの１つで、ウォーキングフォーム診断モードを表します(=0)。

関連項目:

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

MODE_RUNNING

public static final int MODE_RUNNING

診断モードの１つで、ランニングフォーム診断モードを表します(=1)。

関連項目:

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

メソッドの詳細

getAvailableMode

public static int[] getAvailableMode()

フォーム分析機能に設定可能な診断モードを取得します。

戻り値:

設定可能な診断モードを、毎回新しい配列オブジェクトで返します。

関連項目:

getFormAnalyzer(int)

例外:

com.docomostar.lang.UnsupportedOperationException -
フォーム分析機能をサポートしていない場合に発生します。

getFormAnalyzer

public static FormAnalyzer getFormAnalyzer(int mode)

指定した診断モードのフォーム分析機能のインスタンスを返します。

getAvailableMode() で取得した診断モードを指定します。 getAvailableMode() で返される値以外を指定した場合は、 不正な診断モードとして例外が発生します。

既に同一の診断モードを指定したインスタンスが生成されている場合は、 同じインスタンスを返します。

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

パラメータ:

mode - 診断モードを指定します。

戻り値:

フォーム分析機能のインスタンスを返します。

例外:

com.docomostar.lang.UnsupportedOperationException -
フォーム分析機能をサポートしていない場合に発生します。

IllegalArgumentException -
不正な診断モードが指定された場合に発生します。

SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションが、 このメソッドを呼び出した場合に発生します。

com.docomostar.device.DeviceException -
(NO_RESOURCES)
フォーム分析に利用するセンサデバイスを確保できない場合に発生します。

getMode

public int getMode()

このインスタンスの診断モードを返します。

戻り値:

診断モードをを返します。

関連項目:

getFormAnalyzer(int)

start

public void start(boolean continuance)

フォーム分析を開始します。

このメソッドを呼び出すと、ネイティブのフォーム分析機能を開始させます。

既にこのインスタンスからフォーム分析が開始されている状態で、このメソッドが呼び出された場合は例外が発生します。 また、このインスタンス以外からフォーム分析が開始されている状態でも同様に例外が発生します。

フォーム分析中に Star アプリがサスペンドした場合に、 フォーム分析を継続するかどうかを指定することができます。 引数 continuance にフォーム分析を継続させる場合は true、 停止させる場合は false を指定します。
Star アプリのサスペンド時にフォーム分析を停止させる場合、フォーム分析を再開するためにはレジューム処理において、 再度本メソッドを呼び出してください。

フォーム分析を停止させるためには、stop() メソッドを使用します。 サスペンド時にフォーム分析を継続している場合も含め、Star アプリが終了するとフォーム分析は停止します。

パラメータ:

continuance - サスペンド時にフォーム分析を継続するかどうかを指定します。

例外:

com.docomostar.device.DeviceException -
(ILLEGAL_STATE)
既にこのインスタンスによるフォーム分析中である場合に発生します。 また、このインスタンス以外によるフォーム分析中である場合も発生します。

com.docomostar.device.DeviceException -
(UNDEFINED)
何らかの理由により、フォーム分析を開始できない場合に発生します。

stop

public void stop()

フォーム分析を停止します。

このインスタンスから開始したフォーム分析を停止します。 このインスタンスによるフォーム分析中以外に呼ばれた場合、何もしません。

disposeData

public void disposeData()

ネイティブのフォーム分析機能が保持している計測データを削除します。 このインスタンスの診断モードに関連した計測データのみが削除対象です。

このメソッドは、ネイティブのフォーム分析機能の計測状態によらず、計測データの削除が可能です。

getData(Calendar, Calendar) メソッド呼び出し中に別のスレッドからこのメソッドが呼び出された場合、 getData(Calendar, Calendar) 呼び出し終了までこのメソッドの実行は遅延されます。

関連項目:

getFormAnalyzer(int)

getData

public FormData getData(java.util.Calendar start,
                        java.util.Calendar end)

ネイティブのフォーム分析機能が保持している計測データを取得します。 このインスタンスの診断モードに関連した計測データのみが取得対象です。

引数で指定した期間内に計測されたデータを取得します。 指定された期間内に該当するデータが存在しない場合は null を返します。

引数 start、end には null を指定することが可能で、null を指定した場合は期間指定が無いものとして扱います。 例えば、引数 start に null を指定した場合、引数 end に指定された日時より前の計測データを取得します。 また、引数 start、end の両方に null を指定すると、 ネイティブのフォーム分析機能が保持している全ての計測データを取得します。

このメソッドによって取得できる計測データは、ネイティブのフォーム分析機能が保持するデータのうち、 指定された期間内の全計測データの平均値が返されます。 ただし、一部のデータ(歩行情報の歩数など)においては全計測データの合計値で返されるものもあります。

このメソッドは、ネイティブのフォーム分析機能の計測状態によらず、計測データの取得が可能です。

disposeData() メソッド呼び出し中に別のスレッドからこのメソッドが呼び出された場合、 disposeData() 呼び出し終了までこのメソッドの実行は遅延されます。

このメソッドを複数回呼び出した場合、呼び出す度に新しい FormData オブジェクトが生成され、そのオブジェクトへの参照が返されます。

パラメータ:

start - 取得したい期間の開始日時を指定します。開始日時は取得対象として含みません。

end - 取得したい期間の終了日時を指定します。終了日時は取得対象として含みません。

戻り値:

期間内に計測されたデータを返します。

関連項目:

getFormAnalyzer(int)

例外:

IllegalArgumentException -
Calendar 型の引数のいずれかに、システムが提供している以外のオブジェクト (Calendar クラスを継承した未知のクラスのオブジェクト)が渡された場合に発生します。