jp.go.aist.rtm.RTC.port

クラス OutPortDirectProvider

java.lang.Object

jp.go.aist.rtm.RTC.port.OutPortDirectProvider

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

ObjectCreator<OutPortProvider>, ObjectDestructor, OutPortProvider

public class OutPortDirectProvider
extends java.lang.Object
implements OutPortProvider, ObjectCreator<OutPortProvider>, ObjectDestructor

OutPortDirectProvider クラス

データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用し た、push 型データフロー型を実現する OutPort プロバイダクラス。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected NVListHolder	m_properties インタフェース情報を保持するオブジェクトです。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
OutPortDirectProvider() コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected PortStatus	convertReturn(ReturnCode status, EncapsOutputStreamExt data) リターンコード変換 {p.en Return codes conversion}
OutPortProvider	creator_() OutPortDirectProvider を生成する
void	destructor_(java.lang.Object obj) OutPortDirectProvider を破棄する
void	init(Properties prop) 設定初期化 {@.ja OutPortDirectProvider の各種設定を行う。
static void	OutPortDirectProviderInit() モジュール初期化関数 OutPortCorbaCdrConsumer のファクトリを登録する初期化関数。
boolean	publishInterface(NVListHolder properties) Interface情報を公開する {@.ja Interface情報を公開する。
void	publishInterfaceProfile(NVListHolder properties) InterfaceProfile情報を公開する {@.ja InterfaceProfile情報を公開する。
PortStatus	put(byte[] data) [CORBA interface] バッファにデータを書き込む 設定されたバッファにデータを書き込む。
PortStatus	put(CdrDataHolder data) [CORBA interface] バッファにデータを書き込む 設定されたバッファにデータを書き込む。
void	setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer) バッファをセットする {@.ja OutPortProvider がデータを取り出すバッファをセットする。
void	setConnector(OutPortConnector connector) Connectorを設定する。
protected void	setInterfaceType(java.lang.String interfaceType) インタフェースプロフィールのインタフェースタイプを設定する。
void	setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners) リスナを設定する。

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

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

フィールドの詳細

m_properties

protected NVListHolder m_properties

インタフェース情報を保持するオブジェクトです。

コンストラクタの詳細

OutPortDirectProvider

public OutPortDirectProvider()

コンストラクタ

メソッドの詳細

init

public void init(Properties prop)

設定初期化

OutPortDirectProvider の各種設定を行う。与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。

定義:

init インタフェース内 OutPortProvider

パラメータ:

prop - 設定情報

setBuffer

public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)

バッファをセットする

OutPortProvider がデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。

定義:

setBuffer インタフェース内 OutPortProvider

パラメータ:

buffer - OutPortProviderがデータを取り出すバッファへのポインタ

put

public PortStatus put(byte[] data)
               throws org.omg.CORBA.SystemException

[CORBA interface] バッファにデータを書き込む

設定されたバッファにデータを書き込む。

パラメータ:

data - 書込対象データ

例外:

org.omg.CORBA.SystemException

put

public PortStatus put(CdrDataHolder data)
               throws org.omg.CORBA.SystemException

[CORBA interface] バッファにデータを書き込む

設定されたバッファにデータを書き込む。

パラメータ:

data - 書込対象データ

戻り値:

ステータス

例外:

org.omg.CORBA.SystemException

convertReturn

protected PortStatus convertReturn(ReturnCode status,
                                   EncapsOutputStreamExt data)

リターンコード変換 {p.en Return codes conversion}

パラメータ:

status - ReturnCode

戻り値:

PortStatus

creator_

public OutPortProvider creator_()

OutPortDirectProvider を生成する

定義:

creator_ インタフェース内 ObjectCreator<OutPortProvider>

戻り値:

生成されたOutPortProvider

destructor_

public void destructor_(java.lang.Object obj)

OutPortDirectProvider を破棄する

定義:

destructor_ インタフェース内 ObjectDestructor

パラメータ:

obj - 破棄するインタスタンス

OutPortDirectProviderInit

public static void OutPortDirectProviderInit()

モジュール初期化関数

OutPortCorbaCdrConsumer のファクトリを登録する初期化関数。

publishInterfaceProfile

public void publishInterfaceProfile(NVListHolder properties)

InterfaceProfile情報を公開する

InterfaceProfile情報を公開する。 引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されている インターフェースタイプと一致する場合のみ情報を取得する。

定義:

publishInterfaceProfile インタフェース内 OutPortProvider

パラメータ:

properties - InterfaceProfile情報を受け取るホルダオブジェクト

publishInterface

public boolean publishInterface(NVListHolder properties)

Interface情報を公開する

Interface情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトのdataport.interface_type 値を調べ、当該ポー トに設定されていなければNameValue に情報を追加する。すでに同一イ ンターフェースが登録済みの場合は何も行わない。

定義:

publishInterface インタフェース内 OutPortProvider

パラメータ:

properties - properties Interface情報を受け取るホルダオブジェクト

戻り値:

true: 正常終了

setListener

public void setListener(ConnectorBase.ConnectorInfo info,
                        ConnectorListeners listeners)

リスナを設定する。

OutPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortDirectProvider では、以下のコールバック が提供される。

• - ON_BUFFER_WRITE
• - ON_BUFFER_FULL
• - ON_BUFFER_WRITE_TIMEOUT
• - ON_BUFFER_OVERWRITE
• - ON_RECEIVED
• - ON_RECEIVER_FULL
• - ON_RECEIVER_FULL
• - ON_RECEIVER_TIMEOUT
• - ON_RECEIVER_ERROR

定義:

setListener インタフェース内 OutPortProvider

パラメータ:

info - 接続情報

listeners - リスナオブジェクト

setConnector

public void setConnector(OutPortConnector connector)

Connectorを設定する。

OutPort は接続確立時に OutPortConnector オブジェクトを生成し、生 成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は OutPort が保持するので OutPortProvider は OutPortConnector を削 除してはいけない。

定義:

setConnector インタフェース内 OutPortProvider

パラメータ:

connector - OutPortConnector

setInterfaceType

protected void setInterfaceType(java.lang.String interfaceType)

インタフェースプロフィールのインタフェースタイプを設定する。

パラメータ:

interfaceType - インタフェースタイプ