概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

jp.go.aist.dmrc.platform.beans.io
クラス PFSerialPortConnector

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.io.PFSerialPortConnector
すべての実装インタフェース:
PFComponent, PFDataCreateEventSource, PFEventSource, PFProcessTerminateEventSource, PFXMLSerializable, java.io.Serializable
public class PFSerialPortConnector
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFProcessTerminateEventSource, PFXMLSerializable

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

関連項目:
直列化された形式

コンストラクタの概要
PFSerialPortConnector()
          コンポーネントを生成する。
 
メソッドの概要
 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()
          通信速度を取得する。
 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 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()
          読み込んだデータをバイト配列として取得する。
 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 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 setInBufferSize(int id)
          現在開いているポートに対して、受信バッファサイズを設定する。
 void setOutBufferSize(int id)
          現在開いているポートに対して、送信バッファサイズを設定する。
 void setParity(int id)
          パリティを設定する。
protected  void setPortList()
          ポート名一覧の設定
 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
 

コンストラクタの詳細

PFSerialPortConnector

public PFSerialPortConnector()
                      throws PFException
コンポーネントを生成する。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

setComponentID

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

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()
処理完了イベントリスナ配列を取得する。

定義:
インタフェース PFProcessTerminateEventSource 内の getPFProcessTerminateListenerList
戻り値:
イベントリスナイテレータ

addPFProcessTerminateListener

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

定義:
インタフェース PFProcessTerminateEventSource 内の addPFProcessTerminateListener
パラメータ:
lis - 追加対象イベントリスナ

removePFProcessTerminateListener

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

定義:
インタフェース PFProcessTerminateEventSource 内の removePFProcessTerminateListener
パラメータ:
lis - 削除対象イベントリスナ

fireProcessTerminated

protected void fireProcessTerminated(PFProcessTerminateEvent event)
                              throws PFMethodException,
                                     PFRuntimeException
処理完了イベントを発生させる。

パラメータ:
event - 処理完了イベント
例外:
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()
データ生成イベントリスナ配列を取得する。

定義:
インタフェース PFDataCreateEventSource 内の getPFDataCreateListenerList
戻り値:
イベントリスナイテレータ

addPFDataCreateListener

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

定義:
インタフェース PFDataCreateEventSource 内の addPFDataCreateListener
パラメータ:
lis - 追加対象イベントリスナ

removePFDataCreateListener

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

定義:
インタフェース PFDataCreateEventSource 内の removePFDataCreateListener
パラメータ:
lis - 削除対象イベントリスナ

fireDataCreated

protected void fireDataCreated(PFDataCreateEvent event)
                        throws PFMethodException,
                               PFRuntimeException
データ生成イベントを発生させる。

パラメータ:
event - データ生成イベント
例外:
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated

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)
通信速度を設定する。

パラメータ:
id - 設定する通信速度

setStopBits

public void setStopBits(int id)
ストップビットを設定する

パラメータ:
id - 設定するストップビット

setDataBits

public void setDataBits(int id)
データ長を設定する。

パラメータ:
id - 設定するデータビット

setParity

public void setParity(int id)
パリティを設定する。

パラメータ:
id - 設定するパリティ

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
java.util.TooManyListenersException
gnu.io.UnsupportedCommOperationException - パラメータ設定時が正しくない・またはエラー

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 - パラメータ設定が正しくない

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
XMLを出力する.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException

readXML

public void readXML(PFXMLLoader in)
XMLを入力する.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

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

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

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

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

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

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

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

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

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

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

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

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド