jp.go.aist.dmrc.platform.beans.io

クラス PFSerialPortConnector

java.lang.Object

jp.go.aist.dmrc.platform.beans.io.PFSerialPortConnector

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource, PFProcessTerminateEventSource

public class PFSerialPortConnector
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFProcessTerminateEventSource, PFXMLSerializable

シリアル通信（commPort）コンポーネント。

受信時のイベント発生は読み込みモード番号を指定することで処理を変更できる。 デフォルトの番号は0で、受信が途切れた際に受信した文字列をまとめて出力する。QRコードなど 日本語の文字列を含む場合にはこのモードが有用。その他に英数字に限定した文字単位での読み込みと 改行文字が含まれることを前提にした行単位での読み込みモードがある。

シリアル通信コンポーネントから発生するイベントは以下のとおり。

• 処理完了イベント

  トリガ	結果データ	イベント番号
  ポート切断時	切断したポート名 String	0
  ポート接続時	接続したポート名 String	1

  
  
• データ生成イベント

  トリガ	対象データ	イベント番号
  ポートのデータ受信	受信データ (String)	0
  JPEGデータ配列受信	受信データ (byte[])	1

  
  

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	mode_read
protected int	mode_read_byte
protected static int	MODE_READ_BYTE
protected static int	MODE_READ_BYTE_ARRAY_JPEG
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	getByteReadModeArrayJPEG() バイト読込モード(JPEGデータ配列)の番号を取得する。
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

フィールドの詳細

MODE_READ_DEFAULT

protected static final int MODE_READ_DEFAULT

関連項目:

定数フィールド値

MODE_READ_SINGLE_CHAR

protected static final int MODE_READ_SINGLE_CHAR

関連項目:

定数フィールド値

MODE_READ_LINE_TEXT

protected static final int MODE_READ_LINE_TEXT

関連項目:

定数フィールド値

MODE_READ_BYTE

protected static final int MODE_READ_BYTE

関連項目:

定数フィールド値

MODE_READ_BYTE_SINGLE_SIGNED

protected static final int MODE_READ_BYTE_SINGLE_SIGNED

関連項目:

定数フィールド値

MODE_READ_BYTE_SINGLE_UNSIGNED

protected static final int MODE_READ_BYTE_SINGLE_UNSIGNED

関連項目:

定数フィールド値

MODE_READ_BYTE_DOUBLE_SIGNED

protected static final int MODE_READ_BYTE_DOUBLE_SIGNED

関連項目:

定数フィールド値

MODE_READ_BYTE_DOUBLE_UNSIGNED

protected static final int MODE_READ_BYTE_DOUBLE_UNSIGNED

関連項目:

定数フィールド値

MODE_READ_BYTE_ARRAY_JPEG

protected static final int MODE_READ_BYTE_ARRAY_JPEG

関連項目:

定数フィールド値

port

protected transient gnu.io.SerialPort port

シリアルポート
コンポーネントで取得します。

mode_read

protected int mode_read

mode_read_byte

protected int mode_read_byte

コンストラクタの詳細

PFSerialPortConnector

public PFSerialPortConnector()
                      throws PFException

コンポーネントを生成する。

例外:

PFException

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

文字列表現

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()

処理完了イベントリスナ配列を取得する。

定義:

getPFProcessTerminateListenerList インタフェース内 PFProcessTerminateEventSource

戻り値:

イベントリスナイテレータ

addPFProcessTerminateListener

public void addPFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。

定義:

addPFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessTerminateListener

public void removePFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。

定義:

removePFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 削除対象イベントリスナ

fireProcessTerminated

protected void fireProcessTerminated(PFProcessTerminateEvent event)
                              throws PFMethodException,
                                     PFRuntimeException

処理完了イベントを発生させる。

パラメータ:

event - 処理完了イベント

例外:

PFMethodException - イベント伝播先のメソッド起動時のエラー

PFRuntimeException - 予期しない実行時エラー

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()

データ生成イベントリスナ配列を取得する。

定義:

getPFDataCreateListenerList インタフェース内 PFDataCreateEventSource

戻り値:

イベントリスナイテレータ

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)

引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。

定義:

addPFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)

引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。

定義:

removePFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

lis - 削除対象イベントリスナ

fireDataCreated

protected void fireDataCreated(PFDataCreateEvent event)
                        throws PFMethodException,
                               PFRuntimeException

データ生成イベントを発生させる。

パラメータ:

event - データ生成イベント

例外:

PFMethodException - イベント伝播先のメソッド起動時のエラー

PFRuntimeException - 予期しない実行時エラー

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

localeUpdated インタフェース内 PFComponent

getCommPort

public java.lang.String getCommPort()

CommPort名を取得する。

戻り値:

CommPort名

getInBufferSize

public int getInBufferSize()
                    throws PFException

現在開いているポートの、受信バッファサイズを取得します。
ポートが開いていない場合は、プロパティ値を取得します。

戻り値:

受信バッファサイズ

例外:

PFException

getOutBufferSize

public int getOutBufferSize()
                     throws PFException

現在開いているポートの、送信バッファサイズを取得します。
ポートが開いていない場合は、プロパティ値を取得します。

戻り値:

出力バッファサイズ

例外:

PFException

getTimeOut

public int getTimeOut()

タイムアウトを取得する。

戻り値:

タイムアウト

getDATABITS_5

public int getDATABITS_5()

データビット 5

getDATABITS_6

public int getDATABITS_6()

データビット 6

getDATABITS_7

public int getDATABITS_7()

データビット 7

getDATABITS_8

public int getDATABITS_8()

データビット 8

getPARITY_EVEN

public int getPARITY_EVEN()

偶数パリティ

getPARITY_MARK

public int getPARITY_MARK()

マークパリティ

getPARITY_NONE

public int getPARITY_NONE()

パリティなし

getPARITY_ODD

public int getPARITY_ODD()

奇数パリティ

getPARITY_SPACE

public int getPARITY_SPACE()

スペースパリティ

getSTOPBITS_1

public int getSTOPBITS_1()

ストップビット 1 bit

getSTOPBITS_1_5

public int getSTOPBITS_1_5()

ストップビット 1-1/2 bit

getSTOPBITS_2

public int getSTOPBITS_2()

ストップビット 2 bit

getPortID

public gnu.io.CommPortIdentifier getPortID()

ポート識別オブジェクトを取得する。

戻り値:

ポート識別オブジェクト

setCommPort

protected void setCommPort(java.lang.String id)

接続先ポート名を設定する。

パラメータ:

id - 設定するCommPort

setInBufferSize

public void setInBufferSize(int id)

現在開いているポートに対して、受信バッファサイズを設定する。
ポートが開いていない場合はプロパティに設定します。

パラメータ:

id - 設定する受信バッファサイズ

setOutBufferSize

public void setOutBufferSize(int id)

現在開いているポートに対して、送信バッファサイズを設定する。
ポートが開いていない場合はプロパティに設定します。

パラメータ:

id - 設定する出力バッファ

setTimeOut

public void setTimeOut(int id)

タイムアウトを設定する。

パラメータ:

id - 設定するタイムアウト時間

setBaudRate

public void setBaudRate(int id)
                 throws PFException

通信速度を設定する。

パラメータ:

id - 設定する通信速度

例外:

PFException

setStopBits

public void setStopBits(int id)
                 throws PFException

ストップビットを設定する

パラメータ:

id - 設定するストップビット

例外:

PFException

setDataBits

public void setDataBits(int id)
                 throws PFException

データ長を設定する。

パラメータ:

id - 設定するデータビット

例外:

PFException

setParity

public void setParity(int id)
               throws PFException

パリティを設定する。

パラメータ:

id - 設定するパリティ

例外:

PFException

getBaudRate

public int getBaudRate()

通信速度を取得する。

戻り値:

通信速度

例外:

PFException

getDataBits

public int getDataBits()

データビットを取得する。

戻り値:

データビット

例外:

PFException

getStopBits

public int getStopBits()

ストップビットを取得する。

戻り値:

ストップビット

例外:

PFException

getParity

public int getParity()

パリティを取得する。

戻り値:

パリティ

例外:

PFException

getAvailableCharsets

public PFObjectList getAvailableCharsets()

指定可能な文字コード標準名の一覧を取得する。

戻り値:

指定可能な文字コード標準名の一覧

getAvailableCharsetAliases

public PFObjectList getAvailableCharsetAliases()

指定可能な文字コード名の別名を含めた一覧を取得する。

戻り値:

指定可能な文字コード名の別名を含めた一覧

setCharset

public void setCharset(java.lang.String charset)

文字コードを設定する。

パラメータ:

文字コード名 -

getCharset

public java.lang.String getCharset()

文字コードを取得する。

戻り値:

文字コード名

getDefaultCharset

public java.lang.String getDefaultCharset()

デフォルトの文字コードを取得する。

戻り値:

デフォルトの文字コード名

resetCharset

public java.lang.String resetCharset()

文字コードをデフォルトの値に設定する。

戻り値:

デフォルトの文字コード名

init

protected void init()

初期化する。

openPort

public void openPort(java.lang.String portnm)
              throws PFException

指定されたポート名をオープンする。 データ受信時のイベント発生方法は別メソッドによる読み込みモードの指定で処理を変更できる。

パラメータ:

portnm - ポート名

例外:

PFException

addEventListener

protected void addEventListener()
                         throws java.util.TooManyListenersException

データ受信に応じたイベント発生の定義。 読み込みモードの番号を指定しておくことで処理を変更できる。 本コンポーネントでのデフォルトはデータ受信が途切れた時点でイベント発生。

例外:

java.util.TooManyListenersException

setReadMode

public void setReadMode(int mode)

読み込みモードの番号を設定する。 デフォルトは0で、受信が途切れた際に文字列をまとめて出力する。

パラメータ:

mode - モード

getReadMode

public int getReadMode()

読み込みモードの番号を取得する。

戻り値:

モード

getReadModeDefault

public int getReadModeDefault()

読み込みモード(デフォルト)の番号を取得する。 受信が途切れた際に文字列をまとめて出力する。

戻り値:

モード

getReadModeSingleChar

public int getReadModeSingleChar()

読み込みモード(文字)の番号を取得する。 英数字を前提として文字単位で出力する。

戻り値:

モード

getReadModeLineText

public int getReadModeLineText()

読み込みモード(行)の番号を取得する。 改行文字の存在を前提として行単位で出力する。 改行文字が含まれない場合はイベントが発生しない。

戻り値:

モード

getReadModeByte

public int getReadModeByte()

読み込みモード(バイトデータ)の番号を取得する。 バイトデータから数値を取得して出力する。

戻り値:

モード

setByteReadMode

public void setByteReadMode(int mode)

バイト読み込みモードの番号を設定する。 デフォルトは0で、符号付の１バイト数値として読み込む。

パラメータ:

mode - モード番号

getByteReadMode

public int getByteReadMode()

バイト読み込みモードの番号を取得する。

戻り値:

モード番号

getByteReadModeSingleSinged

public int getByteReadModeSingleSinged()

バイト読み込みモード(シングル符号あり)の番号を取得する。

戻り値:

モード番号

getByteReadModeSingleUnsinged

public int getByteReadModeSingleUnsinged()

バイト読み込みモード(シングル符号なし)の番号を取得する。

戻り値:

モード番号

getByteReadModeDoubleSinged

public int getByteReadModeDoubleSinged()

バイト読み込みモード(ダブル符号あり)の番号を取得する。

戻り値:

モード番号

getByteReadModeDoubleUnsinged

public int getByteReadModeDoubleUnsinged()

バイト読み込みモード(ダブル符号なし)の番号を取得する。

戻り値:

モード番号

getByteReadModeArrayJPEG

public int getByteReadModeArrayJPEG()

バイト読込モード(JPEGデータ配列)の番号を取得する。

戻り値:

モード番号

closePort

public void closePort()
               throws PFException

ポートをクローズします。

例外:

PFException

portExists

public boolean portExists(java.lang.String portnm)

指定されたポート名の有無をチェックします。

パラメータ:

portnm - ポート名

戻り値:

ポートが存在する場合true、存在しない場合false

fireDataRead

protected void fireDataRead()
                     throws PFException

データ読込通知用データ生成イベントの発生。

例外:

PFException

firePortConnected

public void firePortConnected()
                       throws PFException

ポート接続通知用処理完了イベントの発生。

例外:

PFException

firePortDisconnected

public void firePortDisconnected()
                          throws PFException

ポート切断通知用処理完了イベントの発生。

例外:

PFException

getReadString

public java.lang.String getReadString()

読み込んだデータを文字列として取得する。

戻り値:

受信データ（文字列）

getReadString

public java.lang.String getReadString(java.lang.String charset)

読み込んだデータを指定した文字コードでデコードした文字列として取得する。

パラメータ:

文字コード名 -

戻り値:

受信データ（文字列）。文字コード名が不適切な場合null。

getReadBytes

public byte[] getReadBytes()

読み込んだデータをバイト配列として取得する。

戻り値:

受信データ（文字列）

getReadByte

public int getReadByte()

受信データのうち選択されたバイトデータを取得します。

戻り値:

受信データ(１バイト）

getReadByteAt

public int getReadByteAt(int idx)
                  throws java.io.IOException

指定されたバイトデータを選択して取得します。

パラメータ:

idx - ｎ番目

例外:

java.io.IOException - IOException I/Oエラー

getReadByteLast

public int getReadByteLast()
                    throws java.io.IOException

読み込まれた最後のバイトデータを選択して取得します。

戻り値:

バイトデータ

例外:

java.io.IOException - IOException I/Oエラー

getReadByteFirst

public int getReadByteFirst()
                     throws java.io.IOException

読み込まれた最初のバイトデータを選択して取得します。

戻り値:

バイトデータ

例外:

java.io.IOException - IOException I/Oエラー

output

public void output(java.lang.String data)
            throws PFException

文字列データをポートへ出力する。

パラメータ:

data - 文字列データ

例外:

PFException

output

public void output(int data)
            throws PFException

バイトデータをポートへ出力する。

パラメータ:

data - バイトデータ

例外:

PFException

output

public void output(byte[] data)
            throws PFException

バイト配列データをポートへ出力する。

パラメータ:

data - バイト配列データ

例外:

PFException

getPortList

public PFObjectList getPortList()
                         throws PFException

シリアルポートの一覧を取得します。

戻り値:

ポート名の一覧

例外:

PFException

setPortList

protected void setPortList()
                    throws PFException

ポート名一覧の設定

例外:

PFException

isCurrentlyOwned

public boolean isCurrentlyOwned(java.lang.String potnm)

指定されたポートの状態を確認します。

戻り値:

接続の有無

例外:

PFException

setSerialPortParams

public void setSerialPortParams(int BaudRate,
                                int DataBits,
                                int StopBits,
                                int Parity)
                         throws PFException

通信状態の設定を行います。

パラメータ:

BaudRate - 通信速度

DataBits - データビット

StopBits - ストップビット

Parity - パリティ

例外:

PFException - パラメータ設定が正しくない

setFlowControlMode_NONE

public void setFlowControlMode_NONE()
                             throws PFException

フローコントロールの設定[なし]

例外:

PFException - パラメータ設定が正しくない

setFlowControlMode_XONXOFF

public void setFlowControlMode_XONXOFF()
                                throws PFException

フローコントロールの設定[on/Xoff]

例外:

PFException - パラメータ設定が正しくない

setFlowControlMode_RTSCTS

public void setFlowControlMode_RTSCTS()
                               throws PFException

フローコントロールの設定[RTSCTS]

例外:

PFException - パラメータ設定が正しくない

setFlowControlMode

public void setFlowControlMode(int mode)
                        throws PFException

フローコントロールモードの設定

パラメータ:

mode - フローコントロールモード

例外:

PFException

getFlowControlMode

public int getFlowControlMode()

フローコントロールモードの取得

パラメータ:

フローコントロールモード -

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

XMLを出力する.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

readXML

public void readXML(PFXMLLoader in)

XMLを入力する.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否