クラス RTC::PublisherFlush

PublisherFlush クラス [詳細]

#include <PublisherFlush.h>

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

RTC::PublisherBase RTC::DataPortStatus

すべてのメンバ一覧

Public 型

typedef coil::Mutex Mutex
typedef coil::Condition< MutexCondition
typedef coil::Guard< coil::MutexGuard

Public メソッド

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

Protected メソッド

void onSend (const cdrMemoryStream &data)
 Connector data listener functions
void onReceived (const cdrMemoryStream &data)
 ON_RECEIVEDのリスナへ通知する。
void onReceiverFull (const cdrMemoryStream &data)
 ON_RECEIVER_FULLのリスナへ通知する。
void onReceiverTimeout (const cdrMemoryStream &data)
 ON_RECEIVER_TIMEOUTのリスナへ通知する。
void onReceiverError (const cdrMemoryStream &data)
 ON_RECEIVER_ERRORのリスナへ通知する。


説明

PublisherFlush クラス

Flush 型 Publisher クラス バッファ内に格納されている未送信データを送信する。 データ送出を待つコンシューマを、送出する側と同じスレッドで動作させる。


型定義


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

DATAPORTSTATUS_ENUM RTC::PublisherFlush::PublisherFlush (  ) 

コンストラクタ

コンストラクタ

引数:
consumer データ送出を待つコンシューマ
property 本Publisherの駆動制御情報を設定したPropertyオブジェクト

virtual RTC::PublisherFlush::~PublisherFlush ( void   )  [virtual]

デストラクタ

デストラクタ 当該Publisherを破棄する際に、PublisherFactoryにより呼び出される。


関数

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

初期化

RTC::PublisherBaseを実装しています。

virtual ReturnCode RTC::PublisherFlush::setConsumer ( InPortConsumer consumer  )  [virtual]

InPortコンシューマのセット

RTC::PublisherBaseを実装しています。

virtual ReturnCode RTC::PublisherFlush::setBuffer ( CdrBufferBase buffer  )  [virtual]

バッファのセット

PublisherFlushでは、バッファを使用しないため、 本メソッドはPORT_ERRORを返す。

引数:
buffer CDRバッファ
戻り値:
PORT_ERROR

virtual ::RTC::DataPortStatus::Enum RTC::PublisherFlush::setListener ( ConnectorInfo profile,
RTC::ConnectorListeners listeners 
) [virtual]

リスナを設定する。

引数:
info ConnectorInfo
listeners ConnectorListeners
戻り値:
PORT_OK 正常終了 INVALID_ARGS 不正な引数

RTC::PublisherBaseを実装しています。

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

データを書き込む

引数:
data 書き込むデータ
sec タイムアウト時間
nsec タイムアウト時間
戻り値:
リターンコード

RTC::PublisherBaseを実装しています。

virtual bool RTC::PublisherFlush::isActive (  )  [virtual]

アクティブ化確認

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

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

RTC::PublisherBaseを実装しています。

virtual ReturnCode RTC::PublisherFlush::activate (  )  [virtual]

アクティブ化

戻り値:
リターンコード

RTC::PublisherBaseを実装しています。

virtual ReturnCode RTC::PublisherFlush::deactivate (  )  [virtual]

非アクティブ化

戻り値:
リターンコード

RTC::PublisherBaseを実装しています。

void RTC::PublisherFlush::onSend ( const cdrMemoryStream &  data  )  [inline, protected]

Connector data listener functions

ON_SENDのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_SEND.

void RTC::PublisherFlush::onReceived ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVEDのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVED.

void RTC::PublisherFlush::onReceiverFull ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVER_FULLのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVER_FULL.

void RTC::PublisherFlush::onReceiverTimeout ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVER_TIMEOUTのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVER_TIMEOUT.

void RTC::PublisherFlush::onReceiverError ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVER_ERRORのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVER_ERROR.


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