jp.go.aist.rtm.RTC.port.publisher
クラス 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  Logbuf rtcout
          
 
コンストラクタの概要
PublisherPeriodic()
          コンストラクタです。
 
メソッドの概要
 ReturnCode activate()
           activate
protected  ReturnCode convertReturn(ReturnCode status)
           convertReturn
 PublisherBase creator_()
           creator_
 ReturnCode deactivate()
           deactivate
 void destructor_(java.lang.Object obj)
           destructor_
 java.lang.String getName()
           getName
 ReturnCode init(Properties prop)
           init initialization
 boolean isActive()
           write
 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
 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)
           write
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

rtcout

protected Logbuf rtcout

コンストラクタの詳細

PublisherPeriodic

public PublisherPeriodic()

コンストラクタです。

送出処理の呼び出し間隔を、Propertyオブジェクトのdataport.push_rateメンバに 設定しておく必要があります。間隔は、Hz単位の浮動小数文字列で指定します。 たとえば、1000.0Hzの場合は、「1000.0」を設定します。

メソッドの詳細

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を駆動するスレッドコンテキストです。コンシューマの送出処理が呼び出されます。

定義:
インタフェース java.lang.Runnable 内の run

open

public int open()

当該Publisherの駆動を開始します。


release

public void release()

駆動フラグがオフとなり、Publisherの駆動が停止します。

ただし、最大1回のみコンシューマの送出処理が呼び出されることがあります。

オーバーライド:
クラス PublisherBase 内の release

init

public ReturnCode init(Properties prop)

init

initialization

定義:
クラス PublisherBase 内の init
パラメータ:
prop -
戻り値:
ReturnCode

setConsumer

public ReturnCode setConsumer(InPortConsumer consumer)

setConsumer

Store InPort consumer

定義:
クラス PublisherBase 内の setConsumer
パラメータ:
consumer -
戻り値:
ReturnCode

setBuffer

public ReturnCode setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)

setBuffer

Setting buffer

定義:
クラス PublisherBase 内の setBuffer
パラメータ:
buffer -
戻り値:
ReturnCode

write

public ReturnCode write(org.omg.CORBA.portable.OutputStream data,
                        int sec,
                        int usec)

write

定義:
クラス PublisherBase 内の write
パラメータ:
data -
sec -
usec -
戻り値:
ReturnCode

write

public ReturnCode write(org.omg.CORBA.portable.OutputStream data)
定義:
クラス PublisherBase 内の write

isActive

public boolean isActive()

write

定義:
クラス PublisherBase 内の isActive
戻り値:
boolean

activate

public ReturnCode activate()

activate

定義:
クラス PublisherBase 内の activate
戻り値:
ReturnCode

deactivate

public ReturnCode deactivate()

deactivate

定義:
クラス PublisherBase 内の deactivate
戻り値:
ReturnCode

creator_

public PublisherBase creator_()

creator_

定義:
インタフェース ObjectCreator<PublisherBase> 内の creator_
戻り値:
Object Created instances

destructor_

public void destructor_(java.lang.Object obj)

destructor_

定義:
インタフェース ObjectDestructor 内の destructor_
パラメータ:
obj - The target instances for destruction

convertReturn

protected ReturnCode convertReturn(ReturnCode status)

convertReturn


PublisherPeriodicInit

public static void PublisherPeriodicInit()

PublisherPeriodicInit


getName

public java.lang.String getName()

getName

定義:
クラス PublisherBase 内の getName
戻り値:
String