NTT DOCOMO and Hitachi Kokusai Electric Know-how & Confidential

com.docomo_um.module
クラス ModuleInfo

java.lang.Object
  上位を拡張 com.docomo_um.module.ModuleInfo

public final class ModuleInfo
extends java.lang.Object

モジュール情報を表すクラスです。


フィールドの概要
static int AREA_INFO_FOMA
          エリア状態の一つで、圏内(FOMA)を表します。
static int AREA_INFO_HSDPA
          エリア状態の一つで、圏内(HSDPA)を表します。
static int AREA_INFO_HSUPA
          エリア状態の一つで、圏内(HSUPA)を表します。
static int AREA_INFO_OUTSIDE
          エリア状態の一つで、圏外を表します。
static int REGULATION_NONE
          規制状態の一つで、規制なしを表します。
static int REGULATION_PACKET
          規制状態の一つで、パケット規制を表します。
static int REGULATION_VOICE
          規制状態の一つで、音声規制を表します。
static int SIGNAL_STATUS_LEVEL1
          アンテナ状態の一つで、レベル1(アンテナ1本)を表します。
static int SIGNAL_STATUS_LEVEL2
          アンテナ状態の一つで、レベル2(アンテナ2本)を表します。
static int SIGNAL_STATUS_LEVEL3
          アンテナ状態の一つで、レベル3(アンテナ3本)を表します。
static int SIGNAL_STATUS_OUTSIDE
          アンテナ状態の一つで、圏外を表します。
 
コンストラクタの概要
ModuleInfo()
          インスタンスを生成します。
 
メソッドの概要
 int getAreaInfo()
          現在のエリア状態を取得します。
 java.lang.String getICCID()
          ICCID(Integrated Circuit Card ID)を取得します。
 java.lang.String getIMEI()
          IMEI(International Mobile Equipment Identity)を取得します。
 java.lang.String getIMEISV()
          IMEISV(International Mobile Equipment Identity Software Version)を取得します。
 java.lang.String getModuleVersion()
          本モジュールのバージョンを取得します。
 int getReceivedPowerIndicator()
          本モジュールが受信する電波の受信電力指標を取得します。
 int getRegulationStatus()
          現在の通信規制状態を取得します。
 int getSignalStatus()
          現在のアンテナ状態を取得します。
 java.lang.String getTelephoneNumber()
          モジュールが利用する電話番号を取得します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait
 

フィールドの詳細

AREA_INFO_FOMA

public static final int AREA_INFO_FOMA
エリア状態の一つで、圏内(FOMA)を表します。

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

AREA_INFO_HSDPA

public static final int AREA_INFO_HSDPA
エリア状態の一つで、圏内(HSDPA)を表します。

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

AREA_INFO_HSUPA

public static final int AREA_INFO_HSUPA
エリア状態の一つで、圏内(HSUPA)を表します。

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

AREA_INFO_OUTSIDE

public static final int AREA_INFO_OUTSIDE
エリア状態の一つで、圏外を表します。

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

REGULATION_PACKET

public static final int REGULATION_PACKET
規制状態の一つで、パケット規制を表します。

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

REGULATION_VOICE

public static final int REGULATION_VOICE
規制状態の一つで、音声規制を表します。 緊急通報の場合は規制の対象になりません。

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

REGULATION_NONE

public static final int REGULATION_NONE
規制状態の一つで、規制なしを表します。

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

SIGNAL_STATUS_OUTSIDE

public static final int SIGNAL_STATUS_OUTSIDE
アンテナ状態の一つで、圏外を表します。

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

SIGNAL_STATUS_LEVEL1

public static final int SIGNAL_STATUS_LEVEL1
アンテナ状態の一つで、レベル1(アンテナ1本)を表します。

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

SIGNAL_STATUS_LEVEL2

public static final int SIGNAL_STATUS_LEVEL2
アンテナ状態の一つで、レベル2(アンテナ2本)を表します。

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

SIGNAL_STATUS_LEVEL3

public static final int SIGNAL_STATUS_LEVEL3
アンテナ状態の一つで、レベル3(アンテナ3本)を表します。

関連項目:
getSignalStatus(), 定数フィールド値
コンストラクタの詳細

ModuleInfo

public ModuleInfo()
インスタンスを生成します。

メソッドの詳細

getAreaInfo

public int getAreaInfo()
                throws ModuleException,
                       DeviceException
現在のエリア状態を取得します。 以下のエリア状態をORで返します。

戻り値:
現在のエリア状態を返します。
例外:
ModuleException - 内部エラーによりエリア状態の取得に失敗した場合に発生します。
DeviceException - デバイスの故障により、エリア状態の取得に失敗した場合に発生します。
関連項目:
AREA_INFO_FOMA, AREA_INFO_HSDPA, AREA_INFO_HSUPA, AREA_INFO_OUTSIDE

getIMEI

public java.lang.String getIMEI()
                         throws ModuleException,
                                DeviceException
IMEI(International Mobile Equipment Identity)を取得します。

戻り値:
IMEIを返します。値が取得できなかった場合、nullを返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
DeviceException - デバイスの故障により、IMEIの取得に失敗した場合に発生します。

getRegulationStatus

public int getRegulationStatus()
                        throws ModuleException,
                               DeviceException
現在の通信規制状態を取得します。 以下の通信規制状態をORで返します。

戻り値:
現在の通信規制状態を返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
DeviceException - デバイスの故障により、通信規制状態の取得に失敗した場合に発生します。
関連項目:
REGULATION_NONE, REGULATION_PACKET, REGULATION_VOICE

getTelephoneNumber

public java.lang.String getTelephoneNumber()
                                    throws ModuleException,
                                           ExternalStatusException,
                                           DeviceException
モジュールが利用する電話番号を取得します。

戻り値:
モジュールが利用する電話番号を返します。値が取得できなかった場合、nullを返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、電話番号の取得に失敗した場合に発生します。
DeviceException - デバイスの故障により、電話番号の取得に失敗した場合に発生します。

getSignalStatus

public int getSignalStatus()
                    throws ModuleException,
                           DeviceException
現在のアンテナ状態を取得します。 以下のアンテナ状態を返します。

戻り値:
現在のアンテナ状態を返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
DeviceException - デバイスの故障により、アンテナ状態の取得に失敗した場合に発生します。
関連項目:
SIGNAL_STATUS_OUTSIDE, SIGNAL_STATUS_LEVEL1, SIGNAL_STATUS_LEVEL2, SIGNAL_STATUS_LEVEL3

getICCID

public java.lang.String getICCID()
                          throws ModuleException,
                                 ExternalStatusException,
                                 DeviceException
ICCID(Integrated Circuit Card ID)を取得します。

戻り値:
ICCIDを返します。値が取得できなかった場合、nullを返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、ICCIDの取得に失敗した場合に発生します。
DeviceException - デバイスの故障により、ICCIDの取得に失敗した場合に発生します。

getIMEISV

public java.lang.String getIMEISV()
                           throws ModuleException,
                                  DeviceException
IMEISV(International Mobile Equipment Identity Software Version)を取得します。

戻り値:
IMEISVを返します。値が取得できなかった場合、nullを返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
DeviceException - デバイスの故障により、IMEISVの取得に失敗した場合に発生します。

getModuleVersion

public java.lang.String getModuleVersion()
                                  throws ModuleException,
                                         DeviceException
本モジュールのバージョンを取得します。

戻り値:
本モジュールのバージョンを返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
DeviceException - デバイスの故障により、バージョンの取得に失敗した場合に発生します。

getReceivedPowerIndicator

public int getReceivedPowerIndicator()
                              throws ModuleException,
                                     DeviceException
本モジュールが受信する電波の受信電力指標を取得します。 受信電力指標は 0 ~ 75 の数値で取得することができます。 受信電力指標を取得していない場合は、0が返却されます。

戻り値:
本モジュールが受信する電波の受信電力指標を返します。
例外:
ModuleException - 内部エラーにより処理が中断した場合に発生します。
DeviceException - デバイスの故障により、受信電力指標の取得に失敗した場合に発生します。

Copyright © 2013 NTT DOCOMO, INC. and Hitachi Kokusai Electric Inc. All Rights Reserved.