com.docomostar.opt.system
クラス ThermoHygrometer

Object
  com.docomostar.opt.system.ThermoHygrometer

public final class ThermoHygrometer
extends Object

携帯電話のネイティブ温湿度計を定義します。 ネイティブ温湿度計から温度及び湿度情報を取得する機能を提供します。

ネイティブ温湿度計がオンになっていれば、 Star アプリケーションが起動しているかどうかにかかわらず、 ネイティブ温湿度計は温度および湿度を蓄積します。 ネイティブ温湿度計がどういった周期間隔で温度および湿度を計測しているかは機種依存です。

導入されたバージョン:

Star-1.5

フィールドの概要

static int	ATTR_THERMO_HYGRO_METER_OFF ネイティブ温湿度計の利用設定の状態の一つで、 ネイティブ温湿度計がオフであることを表します(=0)。
static int	ATTR_THERMO_HYGRO_METER_ON ネイティブ温湿度計の利用設定の状態の一つで、 ネイティブ温湿度計がオンであることを表します(=1)。
static int	DEV_THERMO_HYGRO_METER ネイティブ温湿度計の利用設定の状態を表します(=0)。

メソッドの概要

int	getAttribute(int attr) 温湿度計の属性値を取得します。
int[]	getAvailableData() ネイティブ温湿度計がサポートしている計測可能なデータの種類を取得します。
int	getCount() ネイティブ温湿度計が現在保持している温度・湿度情報の個数を取得します。
ThermoHygroData[]	getData() ネイティブ温湿度計が現在蓄積している、全ての温度・湿度情報を取得します。
ThermoHygroData[]	getData(java.util.Calendar start, java.util.Calendar end) 引数で指定した期間内に計測された温度・湿度情報を取得します。
static ThermoHygrometer	getThermoHygrometer() 温湿度計オブジェクトを取得します。

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

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

フィールドの詳細

ATTR_THERMO_HYGRO_METER_OFF

public static final int ATTR_THERMO_HYGRO_METER_OFF

ネイティブ温湿度計の利用設定の状態の一つで、 ネイティブ温湿度計がオフであることを表します(=0)。

関連項目:

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

ATTR_THERMO_HYGRO_METER_ON

public static final int ATTR_THERMO_HYGRO_METER_ON

ネイティブ温湿度計の利用設定の状態の一つで、 ネイティブ温湿度計がオンであることを表します(=1)。

関連項目:

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

DEV_THERMO_HYGRO_METER

public static final int DEV_THERMO_HYGRO_METER

ネイティブ温湿度計の利用設定の状態を表します(=0)。 属性の取得のみ可能で、制御することはできません。

関連項目:

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

メソッドの詳細

getThermoHygrometer

public static ThermoHygrometer getThermoHygrometer()

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

戻り値:

温湿度計オブジェクトを返します。

例外:

com.docomostar.lang.UnsupportedOperationException -
温湿度計機能が未サポートの場合に発生します。

getAttribute

public int getAttribute(int attr)

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

DEV_THERMO_HYGRO_METER が指定された時のみ、意味のある値を返します。

パラメータ:

attr - 温湿度計の属性の種類を指定します。

戻り値:

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

getAvailableData

public int[] getAvailableData()

ネイティブ温湿度計がサポートしている計測可能なデータの種類を取得します。
ThermoHygroSensor.TEMPERATURE、 ThermoHygroSensor.HUMIDITY のうち、 サポートする計測データの種類の値を含む配列を返します。

戻り値:

ネイティブ温度計がサポートする計測可能なデータの種類を返します。 返される配列は、このインスタンスが内部で保持している配列のコピーです。

getCount

public int getCount()

ネイティブ温湿度計が現在保持している温度・湿度情報の個数を取得します。

このメソッドは、ネイティブ温湿度計の利用設定状態によらず、 温度・湿度情報の個数の取得が可能です。

戻り値:

ネイティブ温湿度計が現在保持している温度・湿度情報の個数を返します。

getData

public ThermoHygroData[] getData()

ネイティブ温湿度計が現在蓄積している、全ての温度・湿度情報を取得します。

温度・湿度情報は ThermoHygroData インスタンスの配列として返され、 各要素は計測日時の降順で(第 0 要素に一番最近のデータが格納される形で)ソートされています。 データが存在しない場合は null を返します。

このメソッドを複数回呼び出した場合、呼び出す度に新しい配列が生成され、その配列への参照が返されます。 ネイティブ温湿度計は周期的に温度・湿度を計測しているため、返される配列の要素数は常に一定とは限りません。

このメソッドは、ネイティブ温湿度計の利用設定状態によらず、 温度・湿度情報の取得が可能です。

戻り値:

温度・湿度情報オブジェクトの配列を返します。

getData

public ThermoHygroData[] getData(java.util.Calendar start,
                                 java.util.Calendar end)

引数で指定した期間内に計測された温度・湿度情報を取得します。

温度・湿度情報は ThermoHygroData インスタンスの配列として返され、 各要素は計測日時の降順で(第 0 要素に指定された期間内で一番最近のデータが格納される形で)ソートされています。 指定された期間内に該当するデータが存在しない場合は null を返します。

引数 start、end には null を指定することが可能で、null を指定した場合は期間指定が無いものとして扱います。 例えば、引数 start に null を指定した場合、引数 end に指定された日時以前の全ての温度・湿度情報を取得します。 また、引数 start、end の両方に null を指定すると、getData() を呼び出した場合と同じ温度・湿度情報を取得します。

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

このメソッドは、ネイティブ温湿度計の利用設定状態によらず、 温度・湿度情報の取得が可能です。

パラメータ:

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

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

戻り値:

期間内に計測された温度・湿度情報オブジェクトの配列を返します。

例外:

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