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

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.port.ConnectorBase
      上位を拡張 jp.go.aist.rtm.RTC.port.OutPortConnector
          上位を拡張 jp.go.aist.rtm.RTC.port.OutPortPullConnector

public class OutPortPullConnector
extends OutPortConnector

OutPortPullConnector クラス

OutPort の pull 型データフローのための Connector クラス。このオブ ジェクトは、接続時に dataflow_type に pull が指定された場合、 OutPort によって生成・所有され、InPortPullConnector と対になって、 データポートの pull 型のデータフローを実現する。一つの接続に対して、 一つのデータストリームを提供する唯一の Connector が対応する。 Connector は 接続時に生成される UUID 形式の ID により区別される。 OutPortPullConnector は以下の三つのオブジェクトを所有し管理する。

OutPort に書き込まれたデータは OutPortPullConnector::write() に渡 され Buffer に書き込まれる。InPortPullConnector が OutPortPullConnector からデータを読み出すことで InPort にデータが 転送される。


入れ子のクラスの概要
 
クラス jp.go.aist.rtm.RTC.port.ConnectorBase から継承された入れ子のクラス/インタフェース
ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder
 
フィールドの概要
protected  BufferBase<org.omg.CORBA.portable.OutputStream> m_buffer
           the pointer to the buffer
protected  OutPortProvider m_provider
           the pointer to the OutPortProvider
 
クラス jp.go.aist.rtm.RTC.port.OutPortConnector から継承されたフィールド
m_isLittleEndian, m_profile, rtcout
 
コンストラクタの概要
OutPortPullConnector(ConnectorBase.ConnectorInfo profile, OutPortProvider provider, ConnectorListeners listeners)
          コンストラクタ {@.ja OutPortPullConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。
OutPortPullConnector(ConnectorBase.ConnectorInfo profile, OutPortProvider provider, ConnectorListeners listeners, BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
          コンストラクタ {@.ja OutPortPullConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。
 
メソッドの概要
 void activate()
          アクティブ化 このコネクタをアクティブ化する
protected  BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)
          Bufferの生成
 void deactivate()
          非アクティブ化 このコネクタを非アクティブ化する
 ReturnCode disconnect()
          接続解除 consumer, publisher, buffer が解体・削除される。
 BufferBase<org.omg.CORBA.portable.OutputStream> getBuffer()
          Buffer を取得する Connector が保持している Buffer を返す
protected  void onConnect()
          接続確立時にコールバックを呼ぶ
protected  void onDisconnect()
          接続切断時にコールバックを呼ぶ
 void setOutPortBase(OutPortBase outportbase)
          OutPortBaseを格納する。
<DataType> ReturnCode
write(DataType data)
          データの書き込み 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_provider

protected OutPortProvider m_provider

the pointer to the OutPortProvider


m_buffer

protected BufferBase<org.omg.CORBA.portable.OutputStream> m_buffer

the pointer to the buffer

コンストラクタの詳細

OutPortPullConnector

public OutPortPullConnector(ConnectorBase.ConnectorInfo profile,
                            OutPortProvider provider,
                            ConnectorListeners listeners,
                            BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
                     throws java.lang.Exception
コンストラクタ

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

パラメータ:
profile - ConnectorInfo
provider - OutPortProvider
listeners - ConnectorListeners 型のリスナオブジェクトリスト
buffer - CdrBufferBase 型のバッファ
例外:
java.lang.Exception

OutPortPullConnector

public OutPortPullConnector(ConnectorBase.ConnectorInfo profile,
                            OutPortProvider provider,
                            ConnectorListeners listeners)
                     throws java.lang.Exception
コンストラクタ

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

パラメータ:
profile - ConnectorInfo
provider - OutPortProvider
listeners - ConnectorListeners 型のリスナオブジェクトリスト
例外:
java.lang.Exception
メソッドの詳細

write

public <DataType> ReturnCode write(DataType data)
データの書き込み

Publisherに対してデータを書き込み、これにより対応するInPortへ データが転送される。

定義:
クラス OutPortConnector 内の write

disconnect

public ReturnCode disconnect()
接続解除

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

定義:
クラス OutPortConnector 内の disconnect
戻り値:
ReturnCode

getBuffer

public BufferBase<org.omg.CORBA.portable.OutputStream> getBuffer()
Buffer を取得する

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

定義:
クラス OutPortConnector 内の getBuffer
戻り値:
Buffer を返す

createBuffer

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

パラメータ:
profile - バッファ種類を指定
戻り値:
生成されたバッファ

onConnect

protected void onConnect()
接続確立時にコールバックを呼ぶ


onDisconnect

protected void onDisconnect()
接続切断時にコールバックを呼ぶ


activate

public void activate()
アクティブ化

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

定義:
クラス ConnectorBase 内の activate

deactivate

public void deactivate()
非アクティブ化

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

定義:
クラス ConnectorBase 内の deactivate

setOutPortBase

public void setOutPortBase(OutPortBase outportbase)
OutPortBaseを格納する。

定義:
クラス OutPortConnector 内の setOutPortBase
パラメータ:
outportbase - OutPortBase