com.docomo_um.module.connection
クラス GPIOConnection

java.lang.Object
  com.docomo_um.module.connection.GPIOConnection

すべての実装されたインタフェース:

Connectable

public class GPIOConnection
extends java.lang.Object
implements Connectable

汎用入出力ポートを表すクラスです。

入力ポート番号、または出力ポート番号のリストを取得するには、 それぞれgetAvailableInPort()、getAvailableOutPort()を使用します。 出力ポートの制御を行うにはsendControlSignal(int outPort, boolean signal)を使用します。 入力ポートの状態を取得するにはreceiveControlSignal(int inPort)を使用します。 出力ポートの初期状態は通信モジュールの実装に依存します。

入力ポートの状態変化通知を受け取るには、setGPIOListener(List, GPIOListener) を使用してリスナを登録します。

留意事項
デバイスの故障などによる障害が発生した場合、または物理的に接続されていない場合、以下のメソッドをコールしても例外は発生しません。

• sendControlSignal(int, boolean)
• getControlSignal(int)
• receiveControlSignal(int)

そのような場合において、このクラスの各メソッドがどのような値を返すのかは、通信モジュールの実装に依存します。

関連項目:

GPIOListener

メソッドの概要

java.util.List<java.lang.Integer>	getAvailableInPort() 利用可能な入力ポート番号のリストを取得します。
java.util.List<java.lang.Integer>	getAvailableOutPort() 利用可能な出力ポート番号のリストを取得します。
boolean	getControlSignal(int outPort) 出力ポートの状態を取得します。
boolean	receiveControlSignal(int inPort) 入力ポートの状態を取得します。
void	sendControlSignal(int outPort, boolean signal) 出力ポートの制御を行います。
void	setGPIOListener(java.util.List<java.lang.Integer> inquiryPorts, GPIOListener listener) 入力ポート状態変化通知リスナを登録します。

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

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

メソッドの詳細

getAvailableInPort

public java.util.List<java.lang.Integer> getAvailableInPort()

利用可能な入力ポート番号のリストを取得します。

戻り値:

入力ポート番号のリストを返します。利用可能な入力ポート番号が存在しない場合、 要素数0のリストを返します。

getAvailableOutPort

public java.util.List<java.lang.Integer> getAvailableOutPort()

利用可能な出力ポート番号のリストを取得します。

戻り値:

出力ポート番号のリストを返します。利用可能な出力ポート番号が存在しない場合、 要素数0のリストを返します。

setGPIOListener

public void setGPIOListener(java.util.List<java.lang.Integer> inquiryPorts,
                            GPIOListener listener)
                     throws ConnectionException

入力ポート状態変化通知リスナを登録します。

このインスタンスに登録できるリスナは1つだけです。 このメソッドを複数回呼出した場合、最後に登録したリスナだけが有効です。 listenerにnullを指定すると、リスナの登録を削除します。

パラメータ:

inquiryPorts - 監視対象の入力ポート番号のリストを指定します。

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

例外:

java.lang.NullPointerException - inquiryPortsにnullを指定した場合に発生します。

java.lang.IllegalArgumentException - inquiryPortsのリストが空の場合、 またはinquiryPortsのリスト内に、利用可能ではない入力ポート番号がある場合に発生します。

ConnectionException - 内部エラーにより処理が中断した場合に発生します。

sendControlSignal

public void sendControlSignal(int outPort,
                              boolean signal)
                       throws ConnectionException

出力ポートの制御を行います。

パラメータ:

outPort - 出力ポート番号を指定します。

signal - 出力ポートをHighにする場合はtrueを、Lowにする場合はfalseを指定します。

例外:

java.lang.IllegalArgumentException - outPortが利用可能な出力ポート番号ではない場合に発生します。

ConnectionException - 内部エラーにより処理が中断した場合に発生します。

receiveControlSignal

public boolean receiveControlSignal(int inPort)
                             throws ConnectionException

入力ポートの状態を取得します。

パラメータ:

inPort - 入力ポート番号を指定します。

戻り値:

入力ポートがHighの場合はtrueを、Lowの場合はfalseを返します。

例外:

java.lang.IllegalArgumentException - inPortが利用可能な入力ポート番号ではない場合に発生します。

ConnectionException - 内部エラーにより処理が中断した場合に発生します。

getControlSignal

public boolean getControlSignal(int outPort)
                         throws ConnectionException

出力ポートの状態を取得します。

パラメータ:

outPort - 出力ポート番号を指定します。

戻り値:

出力ポートがHighの場合はtrueを、Lowの場合はfalseを返します。

例外:

java.lang.IllegalArgumentException - outPortが利用可能な出力ポート番号ではない場合に発生します。

ConnectionException - 内部エラーにより処理が中断した場合に発生します。