com.docomostar.opt.device.location
クラス Compass2

Object
  com.docomostar.device.location.Compass
      com.docomostar.opt.device.location.Compass2

public class Compass2
extends com.docomostar.device.location.Compass

電子コンパスクラスのオプション機能を定義します。

電子コンパスクラスのオプション機能をサポートしている場合には、 Compass.getCompass() は常に Compass2 インスタンスを返します。

導入されたバージョン:

Star-1.3

関連項目:

Compass

フィールドの概要

static int	EVENT_CALIBRATION_COMPLETED イベント検知機能が検知可能なイベントの種類で、 キャリブレーションが完了したことを表します(=2)。
static int	EVENT_CALIBRATION_REQUIRED イベント検知機能が検知可能なイベントの種類で、 キャリブレーションが必要であることを表します(=1)。

メソッドの概要

int[]	getAvailableEvent() イベント検知機能 がサポートする検知イベントを返します。
void	setEventListener(Compass2EventListener listener) イベント検知機能で使用するイベントリスナを設定します。
void	startEventDetection(int event) 電子コンパス機能にイベント検知を依頼します。
void	stopEventDetection() 電子コンパス機能によるイベント検知を停止します。

クラス com.docomostar.device.location.Compass から継承されたメソッド

getAzimuth, getCompass, setEnabled

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

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

フィールドの詳細

EVENT_CALIBRATION_REQUIRED

public static final int EVENT_CALIBRATION_REQUIRED

イベント検知機能が検知可能なイベントの種類で、 キャリブレーションが必要であることを表します(=1)。

電子コンパスが周辺磁気や環境的干渉により磁北位置を正しく認識できなくなった場合、 電子コンパスのキャリブレーションが必要になります。 磁北位置の補正にユーザ操作を必要とするかどうか、 およびユーザ操作方法については機種依存です。

電子コンパス機能を有効化(setEnabled(boolean))の後、 キャリブレーションが必要となった場合にこのイベントが発生します。

イベントが発生した場合、 リスナのactionPerformedメソッド が呼ばれます。 このとき、第 2 引数にこのフィールドの値が渡されます。第 3 引数は使用しません。

関連項目:

定数フィールド値

EVENT_CALIBRATION_COMPLETED

public static final int EVENT_CALIBRATION_COMPLETED

イベント検知機能が検知可能なイベントの種類で、 キャリブレーションが完了したことを表します(=2)。

イベントが発生した場合、 リスナのactionPerformedメソッド が呼ばれます。 このとき、第 2 引数にこのフィールドの値が渡されます。第 3 引数は使用しません。

関連項目:

定数フィールド値

メソッドの詳細

getAvailableEvent

public int[] getAvailableEvent()

イベント検知機能 がサポートする検知イベントを返します。

以下の値のうち、サポートするイベントの値を配列中に返します。

• EVENT_CALIBRATION_REQUIRED
• EVENT_CALIBRATION_COMPLETED

イベント検知機能をサポートしない場合、null が返ります。

戻り値:

サポートする検知イベントを返します。 返される配列は、このオブジェクトが内部で保持している配列のコピーです。

startEventDetection

public void startEventDetection(int event)

電子コンパス機能にイベント検知を依頼します。

本メソッドの呼び出しに成功すると、 電子コンパス機能にイベント検知を依頼し、メソッド呼び出しから戻ります。 電子コンパス機能によりイベントが検知されると、 setEventListener() で指定したリスナにイベントが通知されます。

検知可能なイベントは、以下の通りです。

• EVENT_CALIBRATION_REQUIRED
• EVENT_CALIBRATION_COMPLETED

イベント検知中にサスペンドが発生した場合は、 イベント検知は自動的に停止します。イベント検知を再開する場合には、 レジュームイベント処理において、再度本メソッドを呼び出してください。

パラメータ:

event - 検知イベントを指定します。 複数のイベントを指定可能です。指定する場合は、OR ( "｜" ) で繋げて指定します。

例外:

com.docomostar.device.DeviceException -
(ILLEGAL_STATE)
既にイベント検知中の場合に発生します。

com.docomostar.device.DeviceException -
(ILLEGAL_STATE)
リスナが設定されていない場合に発生します。

IllegalArgumentException -
サポートしない検知イベントを指定した場合に発生します。

stopEventDetection

public void stopEventDetection()

電子コンパス機能によるイベント検知を停止します。
停止しているときに呼ばれた場合、何もしません。

複数のイベント検知を行っている場合は、すべてのイベント検知を停止します。

setEventListener

public void setEventListener(Compass2EventListener listener)

イベント検知機能で使用するイベントリスナを設定します。
引数 listener に null を指定すると、設定されているリスナを解除します。

パラメータ:

listener - リスナを指定します。

例外:

com.docomostar.device.DeviceException -
(ILLEGAL_STATE)
イベント検知中の場合に発生します。