jp.go.aist.rtm.RTC.port
クラス InPortPushConnector

java.lang.Object
  jp.go.aist.rtm.RTC.port.ConnectorBase
      jp.go.aist.rtm.RTC.port.InPortConnector
          jp.go.aist.rtm.RTC.port.InPortPushConnector

public class InPortPushConnector
extends InPortConnector

入れ子のクラスの概要

クラス jp.go.aist.rtm.RTC.port.ConnectorBase から継承された入れ子のクラス/インタフェース

ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder

フィールドの概要

クラス jp.go.aist.rtm.RTC.port.InPortConnector から継承されたフィールド

m_buffer, m_isLittleEndian, m_orb, m_profile, m_spi_orb, rtcout

コンストラクタの概要

InPortPushConnector(ConnectorBase.ConnectorInfo profile, InPortProvider provider, ConnectorListeners listeners, BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
コンストラクタ {@.ja InPortPushConnector のコンストラクタはオブジェクト生成時に下記を 引数にとる。

メソッドの概要

void	activate() アクティブ化 このコネクタをアクティブ化する
protected ReturnCode	convertReturn(ReturnCode status) buffer.ReturnCodeをport.ReturnCodeに変換する。
protected BufferBase<org.omg.CORBA.portable.OutputStream>	createBuffer(ConnectorBase.ConnectorInfo profile) Bufferの生成 与えられた接続情報に基づきバッファを生成する。
void	deactivate() 非アクティブ化 このコネクタを非アクティブ化する
ReturnCode	disconnect() 接続解除 consumer, publisher, buffer が解体・削除される。
protected void	onConnect() 接続確立時にコールバックを呼ぶ
protected void	onDisconnect() 接続切断時にコールバックを呼ぶ
ReturnCode	read(DataRef<org.omg.CORBA.portable.InputStream> data) データの読み出し {@.ja バッファからデータを読み出す。
void	setListener(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners) リスナを設定する。

クラス jp.go.aist.rtm.RTC.port.InPortConnector から継承されたメソッド

getBuffer, id, isLittleEndian, name, profile, setEndian

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

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

コンストラクタの詳細

InPortPushConnector

public InPortPushConnector(ConnectorBase.ConnectorInfo profile,
                           InPortProvider provider,
                           ConnectorListeners listeners,
                           BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
                    throws java.lang.Exception

コンストラクタ

InPortPushConnector のコンストラクタはオブジェクト生成時に下記を 引数にとる。ConnectorInfo は接続情報を含み、この情報に従いバッファ 等を生成する。InPort インターフェースのプロバイダオブジェクトへ のポインタを取り、所有権を持つので、InPortPushConnector は InPortProvider の解体責任を持つ。各種イベントに対するコールバッ ク機構を提供する ConnectorListeners を持ち、適切なタイミングでコー ルバックを呼び出す。データバッファがもし InPortBase から提供され る場合はそのポインタを取る。

パラメータ:

profile - ConnectorInfo

provider - InPortProvider

listeners - ConnectorListeners 型のリスナオブジェクトリスト

buffer - CdrBufferBase 型のバッファ

例外:

java.lang.Exception

メソッドの詳細

setListener

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

クラス InPortConnector の記述:

リスナを設定する。

定義:

クラス InPortConnector 内の setListener

パラメータ:

profile - 接続情報

listeners - リスナオブジェクト

read

public ReturnCode read(DataRef<org.omg.CORBA.portable.InputStream> data)

データの読み出し

バッファからデータを読み出す。正常に読み出せた場合、戻り値は PORT_OK となり、data に読み出されたデータが格納される。それ以外 の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。

定義:

クラス InPortConnector 内の read

戻り値:

PORT_OK 正常終了 BUFFER_EMPTY バッファは空である TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー

disconnect

public ReturnCode disconnect()

接続解除

consumer, publisher, buffer が解体・削除される。

定義:

クラス InPortConnector 内の disconnect

戻り値:

ReturnCode

activate

public void activate()

アクティブ化

このコネクタをアクティブ化する

定義:

クラス ConnectorBase 内の activate

deactivate

public void deactivate()

非アクティブ化

このコネクタを非アクティブ化する

定義:

クラス ConnectorBase 内の deactivate

createBuffer

protected BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)

Bufferの生成

与えられた接続情報に基づきバッファを生成する。

パラメータ:

profile - 接続情報

戻り値:

バッファへのポインタ

onConnect

protected void onConnect()

接続確立時にコールバックを呼ぶ

onDisconnect

protected void onDisconnect()

接続切断時にコールバックを呼ぶ

convertReturn

protected ReturnCode convertReturn(ReturnCode status)

buffer.ReturnCodeをport.ReturnCodeに変換する。

パラメータ:

status - jp.go.aist.rtm.RTC.buffer.ReturnCode

戻り値:

jp.go.aist.rtm.RTC.port.ReturnCode