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

java.lang.Object
  jp.go.aist.rtm.RTC.port.ConnectorBase
      jp.go.aist.rtm.RTC.port.OutPortConnector
          jp.go.aist.rtm.RTC.port.OutPortPushConnector

public class OutPortPushConnector
extends OutPortConnector

入れ子のクラスの概要

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

ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder

フィールドの概要

(package private) ConnectorListeners

m_listeners A reference to a ConnectorListener

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

m_isLittleEndian, m_profile, rtcout

コンストラクタの概要

OutPortPushConnector(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners, InPortConsumer consumer)
コンストラクタ {@.ja OutPortPushConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。

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

メソッドの概要

void	activate() アクティブ化 このコネクタをアクティブ化する
protected BufferBase<org.omg.CORBA.portable.OutputStream>	createBuffer(ConnectorBase.ConnectorInfo profile) create buffer
protected PublisherBase	createPublisher(ConnectorBase.ConnectorInfo profile) create publisher
void	deactivate() Connector deactivation This operation deactivates this connector
ReturnCode	disconnect() 接続解除 consumer, publisher, buffer が解体・削除される。
BufferBase<org.omg.CORBA.portable.OutputStream>	getBuffer() Buffer を取得する Connector が保持している Buffer を返す
protected void	onConnect() Invoke callback when connection is established
protected void	onDisconnect() 接続切断時にコールバックを呼ぶ
void	setOutPortBase(OutPortBase outportbase) OutPortBaseを格納する。
<DataType> ReturnCode	write(DataType data) データの書き込み {@.ja Publisherに対してデータを書き込み、これにより対応するInPortへデー タが転送される。

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

id, isLittleEndian, name, profile, setEndian

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

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

フィールドの詳細

m_listeners

ConnectorListeners m_listeners

A reference to a ConnectorListener

コンストラクタの詳細

OutPortPushConnector

public OutPortPushConnector(ConnectorBase.ConnectorInfo profile,
                            InPortConsumer consumer,
                            ConnectorListeners listeners,
                            BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
                     throws java.lang.Exception

コンストラクタ

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

パラメータ:

profile - ConnectorInfo

consumer - InPortConsumer

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

buffer - CdrBufferBase 型のバッファ

例外:

java.lang.Exception

OutPortPushConnector

public OutPortPushConnector(ConnectorBase.ConnectorInfo profile,
                            ConnectorListeners listeners,
                            InPortConsumer consumer)
                     throws java.lang.Exception

コンストラクタ

OutPortPushConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。ConnectorInfo は接続情報を含み、この情報に従いパブ リッシャやバッファ等を生成する。InPort インターフェースに対する コンシューマオブジェクトへのポインタを取り、所有権を持つので、 OutPortPushConnector は InPortConsumer の解体責任を持つ。各種イ ベントに対するコールバック機構を提供する ConnectorListeners を持 ち、適切なタイミングでコールバックを呼び出す。

パラメータ:

profile - ConnectorInfo

consumer - InPortConsumer

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

例外:

java.lang.Exception

メソッドの詳細

write

public <DataType> ReturnCode write(DataType data)

データの書き込み

Publisherに対してデータを書き込み、これにより対応するInPortへデー タが転送される。正常終了した場合 PORT_OK が返される。それ以外の 場合、エラー値として、CONNECTION_LOST, BUFFER_FULL, BUFFER_ERROR, PORT_ERROR, BUFFER_TIMEOUT, PRECONDITION_NO_MET が 返される。

定義:

クラス OutPortConnector 内の write

パラメータ:

data - データ

戻り値:

ReturnCode PORT_OK 正常終了 CONNECTION_LOST 接続がロストした BUFFER_FULL バッファが一杯である BUFFER_ERROR バッファエラー BUFFER_TIMEOUT バッファへの書き込みがタイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー

disconnect

public ReturnCode disconnect()

接続解除

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

定義:

クラス OutPortConnector 内の disconnect

戻り値:

ReturnCode

activate

public void activate()

アクティブ化

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

定義:

クラス ConnectorBase 内の activate

getBuffer

public BufferBase<org.omg.CORBA.portable.OutputStream> getBuffer()

Buffer を取得する

Connector が保持している Buffer を返す

定義:

クラス OutPortConnector 内の getBuffer

戻り値:

Connector が保持している Buffer

setOutPortBase

public void setOutPortBase(OutPortBase outportbase)

OutPortBaseを格納する。

定義:

クラス OutPortConnector 内の setOutPortBase

パラメータ:

outportbase - OutPortBase

deactivate

public void deactivate()

Connector deactivation

This operation deactivates this connector

定義:

クラス ConnectorBase 内の deactivate

createPublisher

protected PublisherBase createPublisher(ConnectorBase.ConnectorInfo profile)

create publisher

createBuffer

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

create buffer

onConnect

protected void onConnect()

Invoke callback when connection is established

onDisconnect

protected void onDisconnect()

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