クラス RTC::PublisherBase

Publisher 基底クラス [詳細]

#include <PublisherBase.h>

RTC::PublisherBaseに対する継承グラフ

RTC::DataPortStatus RTC::PublisherFlush RTC::PublisherNew RTC::PublisherPeriodic

すべてのメンバ一覧

Public メソッド

virtual DATAPORTSTATUS_ENUM ~PublisherBase (void)
 デストラクタ
virtual ReturnCode init (coil::Properties &prop)=0
 設定初期化
virtual ReturnCode setConsumer (InPortConsumer *consumer)=0
 InPortコンシューマのセット
virtual ReturnCode setBuffer (BufferBase< cdrMemoryStream > *buffer)=0
 バッファのセット
virtual ReturnCode setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0
 リスナを設定する。
virtual ReturnCode write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)=0
 データを書き込む
virtual bool isActive ()=0
 アクティブ化確認
virtual ReturnCode activate ()=0
 アクティブ化
virtual ReturnCode deactivate ()=0
 非アクティブ化
virtual void release ()
 Publisher を破棄する。


説明

Publisher 基底クラス

データ送出タイミングを管理して送出を駆動するPublisher* の基底クラス。 各種 Publisher はこのクラスを継承して詳細を実装する。

から:
0.4.0

コンストラクタとデストラクタ

virtual DATAPORTSTATUS_ENUM RTC::PublisherBase::~PublisherBase ( void   )  [inline, virtual]

デストラクタ


関数

virtual ReturnCode RTC::PublisherBase::init ( coil::Properties prop  )  [pure virtual]

設定初期化

InPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。

引数:
prop 設定情報

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual ReturnCode RTC::PublisherBase::setConsumer ( InPortConsumer consumer  )  [pure virtual]

InPortコンシューマのセット

引数:
consumer InPortコンシューマ

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual ReturnCode RTC::PublisherBase::setBuffer ( BufferBase< cdrMemoryStream > *  buffer  )  [pure virtual]

バッファのセット

引数:
buffer CDRバッファ

virtual ReturnCode RTC::PublisherBase::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
) [pure virtual]

リスナを設定する。

引数:
info ConnectorInfo
listeners ConnectorListeners

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual ReturnCode RTC::PublisherBase::write ( const cdrMemoryStream &  data,
unsigned long  sec,
unsigned long  usec 
) [pure virtual]

データを書き込む

引数:
data 書き込むデータ
sec タイムアウト時間
nsec タイムアウト時間

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual bool RTC::PublisherBase::isActive (  )  [pure virtual]

アクティブ化確認

アクティブ化されているか確認する。

戻り値:
状態確認結果(アクティブ状態:true、非アクティブ状態:false)

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual ReturnCode RTC::PublisherBase::activate (  )  [pure virtual]

アクティブ化

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual ReturnCode RTC::PublisherBase::deactivate (  )  [pure virtual]

非アクティブ化

RTC::PublisherFlush, RTC::PublisherNew, と RTC::PublisherPeriodicで実装されています。

virtual void RTC::PublisherBase::release (  )  [inline, virtual]

Publisher を破棄する。

当該 Publisher を破棄する。 当該 Publisher が不要になった場合に PublisherFactory から呼び出される。


OpenRTMに対してThu Jan 28 13:25:27 2010に生成されました。  doxygen 1.5.5