com.docomostar.opt.device
クラス ThermoHygroSensor

Object
  com.docomostar.opt.device.ThermoHygroSensor

public class ThermoHygroSensor
extends Object

温湿度センサ機能として、温度・湿度を取得する機能を提供します。

温度・湿度の計測方法としては、現在の温度・湿度を得るワンショット計測を提供します。 計測結果は、ThermoHygroData オブジェクトを介して取得することができます。

導入されたバージョン:

Star-1.5

フィールドの概要

static int	HUMIDITY 計測データの種類を示す値で、湿度を表します(=2)。
static int	TEMPERATURE 計測データの種類を示す値で、温度を表します(=1)。

メソッドの概要

int[]	getAvailableData() 実装がサポートしている計測データの種類を取得します。
ThermoHygroData	getCurrentData() 現在の温度・湿度を計測し、結果を取得します(ワンショット計測)。
float	getMaxDataValue(int type) 計測データの最大値を取得します。
float	getMinDataValue(int type) 計測データの最小値を取得します。
static ThermoHygroSensor	getThermoHygroSensor() 温湿度センサ機能のインスタンスを返します。

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

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

フィールドの詳細

TEMPERATURE

public static final int TEMPERATURE

計測データの種類を示す値で、温度を表します(=1)。

関連項目:

定数フィールド値

HUMIDITY

public static final int HUMIDITY

計測データの種類を示す値で、湿度を表します(=2)。

関連項目:

定数フィールド値

メソッドの詳細

getThermoHygroSensor

public static ThermoHygroSensor getThermoHygroSensor()

温湿度センサ機能のインスタンスを返します。
複数回呼び出された場合は、常に同じインスタンスを返します。

実装によっては、温湿度センサ機能をサポートしていない場合があります。

戻り値:

温湿度センサ機能のインスタンスを返します。

例外:

com.docomostar.lang.UnsupportedOperationException -
温湿度センサ機能をサポートしていない場合に発生します。

com.docomostar.device.DeviceException -
(NO_RESOURCES)
温湿度センサデバイスを確保できない場合に発生します。

getAvailableData

public int[] getAvailableData()

実装がサポートしている計測データの種類を取得します。
TEMPERATURE、 HUMIDITY のうち、 サポートする計測データの種類の値を含む配列を返します。

戻り値:

実装がサポートする計測データの種類を返します。 返される配列は、このインスタンスが内部で保持している配列のコピーです。

getMinDataValue

public float getMinDataValue(int type)

計測データの最小値を取得します。
引数で指定された計測データが取り得る値の最小値を取得可能です。 計測データは、この最小値以上の値になります。

パラメータ:

type - 取得する計測データの種類を指定します。TEMPERATURE、 HUMIDITY のいずれかを指定します。

戻り値:

指定された計測データが取り得る値の最小値を返します。

例外:

IllegalArgumentException -
引数 type に不正な値、または実装がサポートしていない値を指定した場合に発生します。

getMaxDataValue

public float getMaxDataValue(int type)

計測データの最大値を取得します。
引数で指定された計測データが取り得る値の最大値を取得可能です。 計測データは、この最大値以下の値になります。

パラメータ:

type - 取得する計測データの種類を指定します。TEMPERATURE、 HUMIDITY のいずれかを指定します。

戻り値:

指定された計測データが取り得る値の最大値を返します。

例外:

IllegalArgumentException -
引数 type に不正な値、または実装がサポートしていない値を指定した場合に発生します。

getCurrentData

public ThermoHygroData getCurrentData()

現在の温度・湿度を計測し、結果を取得します(ワンショット計測)。

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

戻り値:

ワンショット計測結果を格納した ThermoHygroData オブジェクトを返します。

例外:

com.docomostar.device.DeviceException -
(UNDEFINED)
何らかの理由により温度・湿度の取得に失敗した場合に発生します。