jp.go.aist.rtm.RTC.port

クラス InPortDirectConsumer

java.lang.Object

jp.go.aist.rtm.RTC.port.InPortDirectConsumer

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

ObjectCreator<InPortConsumer>, ObjectDestructor, InPortConsumer

public class InPortDirectConsumer
extends java.lang.Object
implements InPortConsumer, ObjectCreator<InPortConsumer>, ObjectDestructor

InPortDirectConsumer クラス

データ転送に CORBA の OpenRTM::InPortCdr インターフェースを利用し た、push 型データフロー型を実現する InPort コンシューマクラス。

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected ReturnCode	convertReturn(PortStatus status) PortStatusをReturnCodeに変換する。
InPortConsumer	creator_() InPortDirectConsumer を生成する
void	destructor_(java.lang.Object obj) Object を破棄する
void	init(Properties prop) 設定初期化 {@.ja InPortConsumerの各種設定を行う。
static void	InPortDirectConsumerInit() モジュール初期化関数 InPortDirectConsumer のファクトリを登録する初期化関数。
void	publishInterfaceProfile(NVListHolder properties) InterfaceProfile情報を公開する {@.ja InterfaceProfile情報を公開する。
ReturnCode	put(org.omg.CORBA.portable.OutputStream data) 接続先へのデータ送信 {@.ja 接続先のポートへデータを送信するための純粋仮想関数。
void	setConnector(OutPortConnector connector) Connectorを設定する。
boolean	subscribeInterface(NVListHolder properties) データ送信通知への登録 指定されたプロパティに基づいて、データ送出通知の受け取り に登録する。
void	unsubscribeInterface(NVListHolder properties) データ送信通知からの登録解除 データ送出通知の受け取りから登録を解除する。

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

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

コンストラクタの詳細

InPortDirectConsumer

public InPortDirectConsumer()

コンストラクタ

メソッドの詳細

init

public void init(Properties prop)

設定初期化

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

定義:

init インタフェース内 InPortConsumer

パラメータ:

prop - 設定情報

put

public ReturnCode put(org.omg.CORBA.portable.OutputStream data)

接続先へのデータ送信

接続先のポートへデータを送信するための純粋仮想関数。 この関数は、以下のリターンコードを返す。

• - PORT_OK: 正常終了。
• - PORT_ERROR: データ送信の過程で何らかのエラーが発生した。
• - SEND_FULL: データを送信したが、相手側バッファがフルだった。
• - SEND_TIMEOUT:データを送信したが、相手側バッファがタイムアウトした。
• - UNKNOWN_ERROR:原因不明のエラー

定義:

put インタフェース内 InPortConsumer

パラメータ:

data - 送信するデータ

戻り値:

リターンコード

publishInterfaceProfile

public void publishInterfaceProfile(NVListHolder properties)

InterfaceProfile情報を公開する

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

定義:

publishInterfaceProfile インタフェース内 InPortConsumer

パラメータ:

properties - InterfaceProfile情報を受け取るプロパティ

subscribeInterface

public boolean subscribeInterface(NVListHolder properties)

データ送信通知への登録

指定されたプロパティに基づいて、データ送出通知の受け取り に登録する。

定義:

subscribeInterface インタフェース内 InPortConsumer

パラメータ:

properties - 登録情報

戻り値:

登録処理結果(登録成功:true、登録失敗:false)

unsubscribeInterface

public void unsubscribeInterface(NVListHolder properties)

データ送信通知からの登録解除

データ送出通知の受け取りから登録を解除する。

定義:

unsubscribeInterface インタフェース内 InPortConsumer

パラメータ:

properties - 登録解除情報

convertReturn

protected ReturnCode convertReturn(PortStatus status)

PortStatusをReturnCodeに変換する。

パラメータ:

status - PortStatus

戻り値:

ReturnCode

creator_

public InPortConsumer creator_()

InPortDirectConsumer を生成する

定義:

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

戻り値:

生成されたInPortConsumer

destructor_

public void destructor_(java.lang.Object obj)

Object を破棄する

定義:

destructor_ インタフェース内 ObjectDestructor

パラメータ:

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

InPortDirectConsumerInit

public static void InPortDirectConsumerInit()

モジュール初期化関数

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

setConnector

public void setConnector(OutPortConnector connector)

Connectorを設定する。

定義:

setConnector インタフェース内 InPortConsumer

パラメータ:

connector - OutPortConnector