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_directOutPort, m_isLittleEndian, m_orb, m_outPortListeners, m_profile, rtcout

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

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`activate()` アクティブ化このコネクタをアクティブ化する
`protected ReturnCode`	`convertReturn(ReturnCode status, DataRef<org.omg.CORBA.portable.OutputStream> data)` 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`	`onBufferEmpty()`
`protected void`	`onBufferRead(DataRef<org.omg.CORBA.portable.OutputStream> data)`
`protected void`	`onBufferReadTimeout()`
`protected void`	`onConnect()` 接続確立時にコールバックを呼ぶ
`protected void`	`onDisconnect()` 接続切断時にコールバックを呼ぶ
`<DataType> ReturnCode`	`read(DataRef<DataType> data)` データの読み出し {@.ja バッファからデータを読み出す。
`void`	`setListener(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners)` リスナを設定する。

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.InPortConnector
getBuffer, id, isLittleEndian, name, profile, setEndian, setOutPort

クラスから継承されたメソッド 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
    
    リスナを設定する。
    
    定義:
    
    setListener クラス内 InPortConnector
    
    パラメータ:
    
    profile - 接続情報
    
    listeners - リスナオブジェクト
  - read
```
public <DataType> ReturnCode read(DataRef<DataType> data)
```
    データの読み出し
    バッファからデータを読み出す。正常に読み出せた場合、戻り値は PORT_OK となり、data に読み出されたデータが格納される。それ以外の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。
    
    定義:
    
    read クラス内 InPortConnector
    
    戻り値:
    
    PORT_OK 正常終了 BUFFER_EMPTY バッファは空である TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー
  - disconnect
```
public ReturnCode disconnect()
```
    接続解除
    consumer, publisher, buffer が解体・削除される。
    
    定義:
    
    disconnect クラス内 InPortConnector
    
    戻り値:
    
    ReturnCode
  - activate
```
public void activate()
```
    アクティブ化
    このコネクタをアクティブ化する
    
    定義:
    
    activate クラス内 ConnectorBase
  - deactivate
```
public void deactivate()
```
    非アクティブ化
    このコネクタを非アクティブ化する
    
    定義:
    
    deactivate クラス内 ConnectorBase
  - createBuffer
```
protected BufferBase<org.omg.CORBA.portable.OutputStream> createBuffer(ConnectorBase.ConnectorInfo profile)
```
    Bufferの生成
    与えられた接続情報に基づきバッファを生成する。
    
    パラメータ:
    
    profile - 接続情報
    
    戻り値:
    
    バッファへのポインタ
  - onConnect
```
protected void onConnect()
```
    接続確立時にコールバックを呼ぶ
  - onDisconnect
```
protected void onDisconnect()
```
    接続切断時にコールバックを呼ぶ
  - onBufferRead
```
protected void onBufferRead(DataRef<org.omg.CORBA.portable.OutputStream> data)
```
  - onBufferEmpty
```
protected void onBufferEmpty()
```
  - onBufferReadTimeout
```
protected void onBufferReadTimeout()
```
  - convertReturn
```
protected ReturnCode convertReturn(ReturnCode status,
                                   DataRef<org.omg.CORBA.portable.OutputStream> data)
```
    buffer.ReturnCodeをport.ReturnCodeに変換する。
    
    パラメータ:
    
    status - jp.go.aist.rtm.RTC.buffer.ReturnCode
    
    戻り値:
    
    jp.go.aist.rtm.RTC.port.ReturnCode

クラス InPortPushConnector

ネストされたクラスのサマリー

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

フィールドのサマリー

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

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

メソッドのサマリー

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

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

コンストラクタの詳細

InPortPushConnector

メソッドの詳細

setListener

read

disconnect

activate

deactivate

createBuffer

onConnect

onDisconnect

onBufferRead

onBufferEmpty

onBufferReadTimeout

convertReturn