|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object jp.go.aist.dmrc.platform.beans.io.PFSerialPortConnector
public class PFSerialPortConnector
シリアル通信(commPort)コンポーネント。
受信時のイベント発生は読み込みモード番号を指定することで処理を変更できる。 デフォルトの番号は0で、受信が途切れた際に受信した文字列をまとめて出力する。QRコードなど 日本語の文字列を含む場合にはこのモードが有用。その他に英数字に限定した文字単位での読み込みと 改行文字が含まれることを前提にした行単位での読み込みモードがある。
シリアル通信コンポーネントから発生するイベントは以下のとおり。
トリガ | 結果データ | イベント番号 |
---|---|---|
ポート切断時 | 切断したポート名 String |
0 |
ポート接続時 | 接続したポート名 String |
1 |
トリガ | 対象データ | イベント番号 |
---|---|---|
ポートのデータ受信 | 受信データ (String) |
0 |
フィールドの概要 | |
---|---|
protected int |
mode_read
|
protected int |
mode_read_byte
|
protected static int |
MODE_READ_BYTE
|
protected static int |
MODE_READ_BYTE_DOUBLE_SIGNED
|
protected static int |
MODE_READ_BYTE_DOUBLE_UNSIGNED
|
protected static int |
MODE_READ_BYTE_SINGLE_SIGNED
|
protected static int |
MODE_READ_BYTE_SINGLE_UNSIGNED
|
protected static int |
MODE_READ_DEFAULT
|
protected static int |
MODE_READ_LINE_TEXT
|
protected static int |
MODE_READ_SINGLE_CHAR
|
protected gnu.io.SerialPort |
port
シリアルポート コンポーネントで取得します。 |
コンストラクタの概要 | |
---|---|
PFSerialPortConnector()
コンポーネントを生成する。 |
メソッドの概要 | |
---|---|
protected void |
addEventListener()
データ受信に応じたイベント発生の定義。 |
void |
addPFDataCreateListener(PFDataCreateListener lis)
引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。 |
void |
addPFProcessTerminateListener(PFProcessTerminateListener lis)
引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。 |
void |
closePort()
ポートをクローズします。 |
protected void |
fireDataCreated(PFDataCreateEvent event)
データ生成イベントを発生させる。 |
protected void |
fireDataRead()
データ読込通知用データ生成イベントの発生。 |
void |
firePortConnected()
ポート接続通知用処理完了イベントの発生。 |
void |
firePortDisconnected()
ポート切断通知用処理完了イベントの発生。 |
protected void |
fireProcessTerminated(PFProcessTerminateEvent event)
処理完了イベントを発生させる。 |
PFObjectList |
getAvailableCharsetAliases()
指定可能な文字コード名の別名を含めた一覧を取得する。 |
PFObjectList |
getAvailableCharsets()
指定可能な文字コード標準名の一覧を取得する。 |
int |
getBaudRate()
通信速度を取得する。 |
int |
getByteReadMode()
バイト読み込みモードの番号を取得する。 |
int |
getByteReadModeDoubleSinged()
バイト読み込みモード(ダブル符号あり)の番号を取得する。 |
int |
getByteReadModeDoubleUnsinged()
バイト読み込みモード(ダブル符号なし)の番号を取得する。 |
int |
getByteReadModeSingleSinged()
バイト読み込みモード(シングル符号あり)の番号を取得する。 |
int |
getByteReadModeSingleUnsinged()
バイト読み込みモード(シングル符号なし)の番号を取得する。 |
java.lang.String |
getCharset()
文字コードを取得する。 |
java.lang.String |
getCommPort()
CommPort名を取得する。 |
int |
getComponentID()
コンポーネントIDを取得する。 |
java.lang.String |
getComponentKey()
コンポーネントキーを取得する。 |
PFMultiLocaleString |
getComponentKeys()
全ロケール分のコンポーネントキーを返す。 |
java.lang.String |
getComponentName()
コンポーネント名称を取得する。 |
java.lang.String |
getComponentPublicName()
コンポーネント公開名を取得する. |
java.lang.String |
getComponentString()
コンポーネントの文字列表現を取得する。 |
int |
getDATABITS_5()
データビット 5 |
int |
getDATABITS_6()
データビット 6 |
int |
getDATABITS_7()
データビット 7 |
int |
getDATABITS_8()
データビット 8 |
int |
getDataBits()
データビットを取得する。 |
java.lang.String |
getDefaultCharset()
デフォルトの文字コードを取得する。 |
int |
getFlowControlMode()
フローコントロールモードの取得 |
int |
getInBufferSize()
現在開いているポートの、受信バッファサイズを取得します。 |
int |
getOutBufferSize()
現在開いているポートの、送信バッファサイズを取得します。 |
int |
getPARITY_EVEN()
偶数パリティ |
int |
getPARITY_MARK()
マークパリティ |
int |
getPARITY_NONE()
パリティなし |
int |
getPARITY_ODD()
奇数パリティ |
int |
getPARITY_SPACE()
スペースパリティ |
int |
getParity()
パリティを取得する。 |
java.util.Iterator |
getPFDataCreateListenerList()
データ生成イベントリスナ配列を取得する。 |
java.util.Iterator |
getPFProcessTerminateListenerList()
処理完了イベントリスナ配列を取得する。 |
gnu.io.CommPortIdentifier |
getPortID()
ポート識別オブジェクトを取得する。 |
PFObjectList |
getPortList()
シリアルポートの一覧を取得します。 |
int |
getReadByte()
受信データのうち選択されたバイトデータを取得します。 |
int |
getReadByteAt(int idx)
指定されたバイトデータを選択して取得します。 |
int |
getReadByteFirst()
読み込まれた最初のバイトデータを選択して取得します。 |
int |
getReadByteLast()
読み込まれた最後のバイトデータを選択して取得します。 |
byte[] |
getReadBytes()
読み込んだデータをバイト配列として取得する。 |
int |
getReadMode()
読み込みモードの番号を取得する。 |
int |
getReadModeByte()
読み込みモード(バイトデータ)の番号を取得する。 |
int |
getReadModeDefault()
読み込みモード(デフォルト)の番号を取得する。 |
int |
getReadModeLineText()
読み込みモード(行)の番号を取得する。 |
int |
getReadModeSingleChar()
読み込みモード(文字)の番号を取得する。 |
java.lang.String |
getReadString()
読み込んだデータを文字列として取得する。 |
java.lang.String |
getReadString(java.lang.String charset)
読み込んだデータを指定した文字コードでデコードした文字列として取得する。 |
int |
getSTOPBITS_1_5()
ストップビット 1-1/2 bit |
int |
getSTOPBITS_1()
ストップビット 1 bit |
int |
getSTOPBITS_2()
ストップビット 2 bit |
int |
getStopBits()
ストップビットを取得する。 |
int |
getTimeOut()
タイムアウトを取得する。 |
protected void |
init()
初期化する。 |
boolean |
isAllowPullTransfer()
他PFからのPull型コンポーネント転送要求に対する可否属性を取得する. |
boolean |
isAllowPushTransfer()
他PFへのPush型コンポーネント転送要求に対する可否属性を取得する. |
boolean |
isAllowRemoteInvocation()
他PFからのコンポーネント連携要求に対する可否属性を取得する. |
boolean |
isCurrentlyOwned(java.lang.String potnm)
指定されたポートの状態を確認します。 |
void |
localeUpdated()
ロケール変更に対応する。 |
void |
openPort(java.lang.String portnm)
指定されたポート名をオープンする。 |
void |
output(byte[] data)
バイト配列データをポートへ出力する。 |
void |
output(int data)
バイトデータをポートへ出力する。 |
void |
output(java.lang.String data)
文字列データをポートへ出力する。 |
boolean |
portExists(java.lang.String portnm)
指定されたポート名の有無をチェックします。 |
void |
readXML(PFXMLLoader in)
XMLを入力する. |
void |
removePFDataCreateListener(PFDataCreateListener lis)
引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。 |
void |
removePFProcessTerminateListener(PFProcessTerminateListener lis)
引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。 |
java.lang.String |
resetCharset()
文字コードをデフォルトの値に設定する。 |
void |
setAllowPullTransfer(boolean flag)
他PFからのPull型コンポーネント転送要求に対する可否属性を設定する. |
void |
setAllowPushTransfer(boolean flag)
他PFへのPush型コンポーネント転送要求に対する可否属性を設定する. |
void |
setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する. |
void |
setBaudRate(int id)
通信速度を設定する。 |
void |
setByteReadMode(int mode)
バイト読み込みモードの番号を設定する。 |
void |
setCharset(java.lang.String charset)
文字コードを設定する。 |
protected void |
setCommPort(java.lang.String id)
接続先ポート名を設定する。 |
void |
setComponentID(int id)
コンポーネントIDを設定する。 |
void |
setComponentKey(java.lang.String key)
コンポーネントキーを設定する。 |
void |
setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。 |
void |
setComponentPublicName(java.lang.String publicName)
コンポーネント公開名を設定する. |
void |
setDataBits(int id)
データ長を設定する。 |
void |
setFlowControlMode_NONE()
フローコントロールの設定[なし] |
void |
setFlowControlMode_RTSCTS()
フローコントロールの設定[RTSCTS] |
void |
setFlowControlMode_XONXOFF()
フローコントロールの設定[on/Xoff] |
void |
setFlowControlMode(int mode)
フローコントロールモードの設定 |
void |
setInBufferSize(int id)
現在開いているポートに対して、受信バッファサイズを設定する。 |
void |
setOutBufferSize(int id)
現在開いているポートに対して、送信バッファサイズを設定する。 |
void |
setParity(int id)
パリティを設定する。 |
protected void |
setPortList()
ポート名一覧の設定 |
void |
setReadMode(int mode)
読み込みモードの番号を設定する。 |
void |
setSerialPortParams(int BaudRate,
int DataBits,
int StopBits,
int Parity)
通信状態の設定を行います。 |
void |
setStopBits(int id)
ストップビットを設定する |
void |
setTimeOut(int id)
タイムアウトを設定する。 |
void |
writeXML(PFXMLGenerator out)
XMLを出力する. |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
protected static final int MODE_READ_DEFAULT
protected static final int MODE_READ_SINGLE_CHAR
protected static final int MODE_READ_LINE_TEXT
protected static final int MODE_READ_BYTE
protected static final int MODE_READ_BYTE_SINGLE_SIGNED
protected static final int MODE_READ_BYTE_SINGLE_UNSIGNED
protected static final int MODE_READ_BYTE_DOUBLE_SIGNED
protected static final int MODE_READ_BYTE_DOUBLE_UNSIGNED
protected transient gnu.io.SerialPort port
protected int mode_read
protected int mode_read_byte
コンストラクタの詳細 |
---|
public PFSerialPortConnector() throws PFException
PFException
メソッドの詳細 |
---|
public java.lang.String getComponentName()
PFComponent
内の getComponentName
public java.lang.String getComponentKey()
PFComponent
内の getComponentKey
public void setComponentKey(java.lang.String key)
PFComponent
内の setComponentKey
key
- コンポーネントキーpublic PFMultiLocaleString getComponentKeys()
public void setComponentKeys(PFMultiLocaleString keys)
keys
- 全ロケール分のコンポーネントキーpublic void setComponentID(int id)
PFComponentBus
から設定される。
各コンポーネント内では操作しないこと。
PFComponent
内の setComponentID
id
- 設定するコンポーネントIDpublic java.lang.String getComponentString()
PFComponent
内の getComponentString
public int getComponentID()
PFComponent
内の getComponentID
public java.util.Iterator getPFProcessTerminateListenerList()
PFProcessTerminateEventSource
内の getPFProcessTerminateListenerList
public void addPFProcessTerminateListener(PFProcessTerminateListener lis)
PFProcessTerminateEventSource
内の addPFProcessTerminateListener
lis
- 追加対象イベントリスナpublic void removePFProcessTerminateListener(PFProcessTerminateListener lis)
PFProcessTerminateEventSource
内の removePFProcessTerminateListener
lis
- 削除対象イベントリスナprotected void fireProcessTerminated(PFProcessTerminateEvent event) throws PFMethodException, PFRuntimeException
event
- 処理完了イベント
PFMethodException
- イベント伝播先のメソッド起動時のエラー
PFRuntimeException
- 予期しない実行時エラーpublic java.util.Iterator getPFDataCreateListenerList()
PFDataCreateEventSource
内の getPFDataCreateListenerList
public void addPFDataCreateListener(PFDataCreateListener lis)
PFDataCreateEventSource
内の addPFDataCreateListener
lis
- 追加対象イベントリスナpublic void removePFDataCreateListener(PFDataCreateListener lis)
PFDataCreateEventSource
内の removePFDataCreateListener
lis
- 削除対象イベントリスナprotected void fireDataCreated(PFDataCreateEvent event) throws PFMethodException, PFRuntimeException
event
- データ生成イベント
PFMethodException
- イベント伝播先のメソッド起動時のエラー
PFRuntimeException
- 予期しない実行時エラーpublic void localeUpdated()
PFComponent
内の localeUpdated
public java.lang.String getCommPort()
public int getInBufferSize() throws PFException
PFException
public int getOutBufferSize() throws PFException
PFException
public int getTimeOut()
public int getDATABITS_5()
public int getDATABITS_6()
public int getDATABITS_7()
public int getDATABITS_8()
public int getPARITY_EVEN()
public int getPARITY_MARK()
public int getPARITY_NONE()
public int getPARITY_ODD()
public int getPARITY_SPACE()
public int getSTOPBITS_1()
public int getSTOPBITS_1_5()
public int getSTOPBITS_2()
public gnu.io.CommPortIdentifier getPortID()
protected void setCommPort(java.lang.String id)
id
- 設定するCommPortpublic void setInBufferSize(int id)
id
- 設定する受信バッファサイズpublic void setOutBufferSize(int id)
id
- 設定する出力バッファpublic void setTimeOut(int id)
id
- 設定するタイムアウト時間public void setBaudRate(int id) throws PFException
id
- 設定する通信速度
PFException
public void setStopBits(int id) throws PFException
id
- 設定するストップビット
PFException
public void setDataBits(int id) throws PFException
id
- 設定するデータビット
PFException
public void setParity(int id) throws PFException
id
- 設定するパリティ
PFException
public int getBaudRate()
PFException
public int getDataBits()
PFException
public int getStopBits()
PFException
public int getParity()
PFException
public PFObjectList getAvailableCharsets()
public PFObjectList getAvailableCharsetAliases()
public void setCharset(java.lang.String charset)
文字コード名
- public java.lang.String getCharset()
public java.lang.String getDefaultCharset()
public java.lang.String resetCharset()
protected void init()
public void openPort(java.lang.String portnm) throws PFException
portnm
- ポート名
PFException
protected void addEventListener() throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void setReadMode(int mode)
mode
- モードpublic int getReadMode()
public int getReadModeDefault()
public int getReadModeSingleChar()
public int getReadModeLineText()
public int getReadModeByte()
public void setByteReadMode(int mode)
mode
- モード番号public int getByteReadMode()
public int getByteReadModeSingleSinged()
public int getByteReadModeSingleUnsinged()
public int getByteReadModeDoubleSinged()
public int getByteReadModeDoubleUnsinged()
public void closePort() throws PFException
PFException
public boolean portExists(java.lang.String portnm)
portnm
- ポート名
protected void fireDataRead() throws PFException
PFException
public void firePortConnected() throws PFException
PFException
public void firePortDisconnected() throws PFException
PFException
public java.lang.String getReadString()
public java.lang.String getReadString(java.lang.String charset)
文字コード名
-
public byte[] getReadBytes()
public int getReadByte()
public int getReadByteAt(int idx) throws java.io.IOException
idx
- n番目
java.io.IOException
- IOException I/Oエラーpublic int getReadByteLast() throws java.io.IOException
java.io.IOException
- IOException I/Oエラーpublic int getReadByteFirst() throws java.io.IOException
java.io.IOException
- IOException I/Oエラーpublic void output(java.lang.String data) throws PFException
data
- 文字列データ
PFException
public void output(int data) throws PFException
data
- バイトデータ
PFException
public void output(byte[] data) throws PFException
data
- バイト配列データ
PFException
public PFObjectList getPortList() throws PFException
PFException
protected void setPortList() throws PFException
PFException
public boolean isCurrentlyOwned(java.lang.String potnm)
PFException
public void setSerialPortParams(int BaudRate, int DataBits, int StopBits, int Parity) throws PFException
BaudRate
- 通信速度DataBits
- データビットStopBits
- ストップビットParity
- パリティ
PFException
- パラメータ設定が正しくないpublic void setFlowControlMode_NONE() throws PFException
PFException
- パラメータ設定が正しくないpublic void setFlowControlMode_XONXOFF() throws PFException
PFException
- パラメータ設定が正しくないpublic void setFlowControlMode_RTSCTS() throws PFException
PFException
- パラメータ設定が正しくないpublic void setFlowControlMode(int mode) throws PFException
mode
- フローコントロールモード
PFException
public int getFlowControlMode()
フローコントロールモード
- public void writeXML(PFXMLGenerator out) throws java.io.IOException
PFXMLSerializable
内の writeXML
out
- XML出力ユーティリティ
java.io.IOException
public void readXML(PFXMLLoader in)
PFXMLSerializable
内の readXML
in
- XML入力ユーティリティpublic java.lang.String getComponentPublicName()
PFComponent
内の getComponentPublicName
public void setComponentPublicName(java.lang.String publicName) throws PFComponentException
PFComponent
内の setComponentPublicName
publicName
- 設定するコンポーネント公開名
PFComponentException
- 規約に反する名前が設定されようとした場合public boolean isAllowRemoteInvocation()
PFComponent
内の isAllowRemoteInvocation
public void setAllowRemoteInvocation(boolean flag)
PFComponent
内の setAllowRemoteInvocation
flag
- コンポーネント連携要求に対する可否public boolean isAllowPullTransfer()
PFComponent
内の isAllowPullTransfer
public void setAllowPullTransfer(boolean flag)
PFComponent
内の setAllowPullTransfer
flag
- Pull型コンポーネント転送要求に対する可否public boolean isAllowPushTransfer()
PFComponent
内の isAllowPushTransfer
public void setAllowPushTransfer(boolean flag)
PFComponent
内の setAllowPushTransfer
flag
- Push型コンポーネント転送要求に対する可否
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |