PublisherPeriodic

java.lang.Object
- jp.go.aist.rtm.RTC.port.publisher.PublisherBase
- - jp.go.aist.rtm.RTC.port.publisher.PublisherPeriodic

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

java.lang.Runnable, ObjectCreator<PublisherBase>, ObjectDestructor
```
public class PublisherPeriodic
extends PublisherBase
implements java.lang.Runnable, ObjectCreator<PublisherBase>, ObjectDestructor
```
一定時間おきにコンシューマの送出処理を呼び出すPublisherです。

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

ネストされたクラス
修飾子とタイプクラスと説明

protected static class PublisherPeriodic.Policy

ネストされたクラス
修飾子とタイプ	クラスと説明
`protected static class`	`PublisherPeriodic.Policy`

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected Logbuf rtcout

フィールド
修飾子とタイプ	フィールドと説明
`protected Logbuf`	`rtcout`

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

コンストラクタ
コンストラクタと説明

PublisherPeriodic()
コンストラクタ

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

メソッドのサマリー

メソッド
修飾子とタイプ	メソッドと説明
`ReturnCode`	`activate()` activate
`protected ReturnCode`	`convertReturn(ReturnCode status, org.omg.CORBA.portable.OutputStream data)` convertReturn
`protected boolean`	`createTask(Properties prop)` Setting Task
`PublisherBase`	`creator_()` creator_
`ReturnCode`	`deactivate()` deactivate
`void`	`destructor_(java.lang.Object obj)` destructor_
`java.lang.String`	`getName()` getName
`ReturnCode`	`init(Properties prop)` 初期化 {@.ja このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び出す必要がある。
`protected ReturnCode`	`invokeListener(ReturnCode status, org.omg.CORBA.portable.OutputStream data)`
`boolean`	`isActive()` write
`protected void`	`onBufferEmpty()` Connector listener functions
`protected void`	`onBufferFull(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onBufferRead(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onBufferWrite(org.omg.CORBA.portable.OutputStream data)` Connector data listener functions
`protected void`	`onBufferWriteTimeout(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onReceived(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onReceiverError(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onReceiverFull(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onReceiverTimeout(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onSend(org.omg.CORBA.portable.OutputStream data)`
`protected void`	`onSenderEmpty()`
`protected void`	`onSenderError()`
`int`	`open()` 当該Publisherの駆動を開始します。
`static void`	`PublisherPeriodicInit()` PublisherPeriodicInit
`protected ReturnCode`	`pushAll()` pushAll push all policy
`protected ReturnCode`	`pushFifo()` pushFifo push "fifo" policy
`protected ReturnCode`	`pushNew()` pushNew push "new" policy
`protected ReturnCode`	`pushSkip()` pushSkip push "skip" policy
`void`	`release()` 駆動フラグがオフとなり、Publisherの駆動が停止します。
`void`	`run()` 当該Publisherを駆動するスレッドコンテキストです。
`ReturnCode`	`setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)` setBuffer Setting buffer
`ReturnCode`	`setConsumer(InPortConsumer consumer)` setConsumer Store InPort consumer
`ReturnCode`	`setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)` Setting buffer pointer
`protected void`	`setPushPolicy(Properties prop)` Setting PushPolicy
`int`	`svc()` 当該Publisherを駆動するスレッドコンテキストです。
`void`	`update()` 本Publisher実装では、何も行いません。
`ReturnCode`	`write(org.omg.CORBA.portable.OutputStream data)`
`ReturnCode`	`write(org.omg.CORBA.portable.OutputStream data, int sec, int usec)` データを書き込む {@.ja Publisher が保持するバッファに対してデータを書き込む。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - rtcout
```
protected Logbuf rtcout
```
- コンストラクタの詳細
  - PublisherPeriodic
```
public PublisherPeriodic()
```
    コンストラクタ
- メソッドの詳細
  - update
```
public void update()
```
    本Publisher実装では、何も行いません。
  - svc
```
public int svc()
```
    当該Publisherを駆動するスレッドコンテキストです。コンシューマの送出処理が呼び出されます。
  - pushAll
```
protected ReturnCode pushAll()
```
    pushAll
    
    push all policy
    
    戻り値:
    ReturnCode
  - pushFifo
```
protected ReturnCode pushFifo()
```
    pushFifo
    
    push "fifo" policy
    
    戻り値:
    ReturnCode
  - pushSkip
```
protected ReturnCode pushSkip()
```
    pushSkip
    
    push "skip" policy
    
    戻り値:
    ReturnCode
  - pushNew
```
protected ReturnCode pushNew()
```
    pushNew
    
    push "new" policy
    
    戻り値:
    ReturnCode
  - run
```
public void run()
```
    当該Publisherを駆動するスレッドコンテキストです。コンシューマの送出処理が呼び出されます。
    
    定義:
    
    run インタフェース内 java.lang.Runnable
  - open
```
public int open()
```
    当該Publisherの駆動を開始します。
  - release
```
public void release()
```
    駆動フラグがオフとなり、Publisherの駆動が停止します。
    
    ただし、最大１回のみコンシューマの送出処理が呼び出されることがあります。
    
    オーバーライド:
    
    release クラス内 PublisherBase
  - init
```
public ReturnCode init(Properties prop)
```
    初期化
    このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び出す必要がある。引数には、このオブジェクトの各種設定情報を含む Properties を与える。少なくとも、送出処理の呼び出し周期を単位 Hz の数値として Propertyオブジェクトの publisher.push_rate をキーとする要素に設定する必要がある。周期 5ms すなわち、200Hzの場合、 200.0 を設定する。 dataport.publisher.push_rate が未設定の場合、 false が返される。データをプッシュする際のポリシーとして publisher.push_policy をキーとする値に、all, fifo, skip, new のいずれかを与えることができる。以下のオプションを与えることができる。
    - publisher.thread_type:スレッドのタイプ (文字列、デフォルト: default)
    - publisher.push_rate: Publisherの送信周期 (数値)
    - publisher.push_policy: Pushポリシー (all, fifo, skip, new)
    - publisher.skip_count: 上記ポリシが skip のときのスキップ数
    - measurement.exec_time: タスク実行時間計測 (enable/disable)
    - measurement.exec_count: タスク関数実行時間計測周期 (数値, 回数)
    - measurement.period_time: タスク周期時間計測 (enable/disable)
    - measurement.period_count: タスク周期時間計測周期 (数値, 回数)
    定義:
    
    init クラス内 PublisherBase
    
    パラメータ:
    prop - 本Publisherの駆動制御情報を設定したPropertyオブジェクト
    
    戻り値:
    PORT_OK 正常終了 INVALID_ARGS Properties が不正な値を含む
  - setPushPolicy
```
protected void setPushPolicy(Properties prop)
```
    Setting PushPolicy
  - createTask
```
protected boolean createTask(Properties prop)
```
    Setting Task
  - setConsumer
```
public ReturnCode setConsumer(InPortConsumer consumer)
```
    setConsumer
    
    Store InPort consumer
    
    定義:
    
    setConsumer クラス内 PublisherBase
    
    パラメータ:
    consumer -
    
    戻り値:
    ReturnCode
  - setBuffer
```
public ReturnCode setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
```
    setBuffer
    
    Setting buffer
    
    定義:
    
    setBuffer クラス内 PublisherBase
    
    パラメータ:
    buffer -
    
    戻り値:
    ReturnCode
  - setListener
```
public ReturnCode setListener(ConnectorBase.ConnectorInfo info,
                     ConnectorListeners listeners)
```
    Setting buffer pointer
    
    定義:
    
    setListener クラス内 PublisherBase
    
    戻り値:
    ReturnCode
  - write
```
public ReturnCode write(org.omg.CORBA.portable.OutputStream data,
               int sec,
               int usec)
```
    データを書き込む
    Publisher が保持するバッファに対してデータを書き込む。コンシューマ、バッファ、リスナ等が適切に設定されていない等、Publisher オブジェクトが正しく初期化されていない場合、この関数を呼び出すとエラーコード PRECONDITION_NOT_MET が返され、バッファへの書き込み等の操作は一切行われない。バッファへの書き込みと、InPortへのデータの送信は非同期的に行われるため、この関数は、InPortへのデータ送信の結果を示す、 CONNECTION_LOST, BUFFER_FULL などのリターンコードを返すことがある。この場合、データのバッファへの書き込みは行われない。バッファへの書き込みに対して、バッファがフル状態、バッファのエラー、バッファへの書き込みがタイムアウトした場合、バッファの事前条件が満たされない場合にはそれぞれ、エラーコード BUFFER_FULL, BUFFER_ERROR, BUFFER_TIMEOUT, PRECONDITION_NOT_MET が返される。これら以外のエラーの場合、PORT_ERROR が返される。
    
    定義:
    
    write クラス内 PublisherBase
    
    パラメータ:
    data - 書き込むデータ
    sec - タイムアウト時間
    usec - タイムアウト時間
    
    戻り値:
    PORT_OK 正常終了 PRECONDITION_NO_MET consumer, buffer, listener等が適切に設定されていない等、このオブジェクトの事前条件を満たさない場合。 CONNECTION_LOST 接続が切断されたことを検知した。 BUFFER_FULL バッファがフル状態である。 BUFFER_ERROR バッファに何らかのエラーが生じた場合。 NOT_SUPPORTED サポートされない操作が行われた。 TIMEOUT タイムアウトした。
  - write
```
public ReturnCode write(org.omg.CORBA.portable.OutputStream data)
```
    定義:
    
    write クラス内 PublisherBase
  - isActive
```
public boolean isActive()
```
    write
    
    定義:
    
    isActive クラス内 PublisherBase
    
    戻り値:
    boolean
  - activate
```
public ReturnCode activate()
```
    activate
    
    定義:
    
    activate クラス内 PublisherBase
    
    戻り値:
    ReturnCode
  - deactivate
```
public ReturnCode deactivate()
```
    deactivate
    
    定義:
    
    deactivate クラス内 PublisherBase
    
    戻り値:
    ReturnCode
  - creator_
```
public PublisherBase creator_()
```
    creator_
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<PublisherBase>
    
    戻り値:
    Object Created instances
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    destructor_
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    obj - The target instances for destruction
  - convertReturn
```
protected ReturnCode convertReturn(ReturnCode status,
                       org.omg.CORBA.portable.OutputStream data)
```
    convertReturn
  - invokeListener
```
protected ReturnCode invokeListener(ReturnCode status,
                        org.omg.CORBA.portable.OutputStream data)
```
  - PublisherPeriodicInit
```
public static void PublisherPeriodicInit()
```
    PublisherPeriodicInit
  - getName
```
public java.lang.String getName()
```
    getName
    
    定義:
    
    getName クラス内 PublisherBase
    
    戻り値:
    String
  - onBufferWrite
```
protected void onBufferWrite(org.omg.CORBA.portable.OutputStream data)
```
    Connector data listener functions
  - onBufferFull
```
protected void onBufferFull(org.omg.CORBA.portable.OutputStream data)
```
  - onBufferWriteTimeout
```
protected void onBufferWriteTimeout(org.omg.CORBA.portable.OutputStream data)
```
  - onBufferRead
```
protected void onBufferRead(org.omg.CORBA.portable.OutputStream data)
```
  - onSend
```
protected void onSend(org.omg.CORBA.portable.OutputStream data)
```
  - onReceived
```
protected void onReceived(org.omg.CORBA.portable.OutputStream data)
```
  - onReceiverFull
```
protected void onReceiverFull(org.omg.CORBA.portable.OutputStream data)
```
  - onReceiverTimeout
```
protected void onReceiverTimeout(org.omg.CORBA.portable.OutputStream data)
```
  - onReceiverError
```
protected void onReceiverError(org.omg.CORBA.portable.OutputStream data)
```
  - onBufferEmpty
```
protected void onBufferEmpty()
```
    Connector listener functions
  - onSenderEmpty
```
protected void onSenderEmpty()
```
  - onSenderError
```
protected void onSenderError()
```

クラス PublisherPeriodic

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

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

rtcout

コンストラクタの詳細

PublisherPeriodic

メソッドの詳細

update

svc

pushAll

pushFifo

pushSkip

pushNew

run

open

release

init

setPushPolicy

createTask

setConsumer

setBuffer

setListener

write

write

isActive

activate

deactivate

creator_

destructor_

convertReturn

invokeListener

PublisherPeriodicInit

getName

onBufferWrite

onBufferFull

onBufferWriteTimeout

onBufferRead

onSend

onReceived

onReceiverFull

onReceiverTimeout

onReceiverError

onBufferEmpty

onSenderEmpty

onSenderError