OpenRTM-aist 2.1.0
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
RTC::PublisherFlush クラス

PublisherFlush クラス [詳解]

#include <PublisherFlush.h>

RTC::PublisherFlush の継承関係図
Inheritance graph
[凡例]
RTC::PublisherFlush 連携図
Collaboration graph
[凡例]

公開メンバ関数

 PublisherFlush ()
 コンストラクタ
 
 ~PublisherFlush () override
 デストラクタ
 
DataPortStatus init (coil::Properties &prop) override
 初期化
 
DataPortStatus setConsumer (InPortConsumer *consumer) override
 InPortコンシューマのセット
 
DataPortStatus setBuffer (CdrBufferBase *buffer) override
 バッファのセット
 
::RTC::DataPortStatus setListener (ConnectorInfo &info, RTC::ConnectorListenersBase *listeners) override
 リスナを設定する。
 
DataPortStatus write (ByteDataStreamBase *data, std::chrono::nanoseconds timeout=std::chrono::nanoseconds(-1)) override
 データを書き込む
 
bool isActive () override
 アクティブ化確認
 
DataPortStatus activate () override
 アクティブ化する
 
DataPortStatus deactivate () override
 非アクティブ化する
 
- 基底クラス RTC::PublisherBase に属する継承公開メンバ関数
virtual ~PublisherBase ()=default
 デストラクタ
 
virtual DataPortStatus setBuffer (BufferBase< ByteData > *buffer)=0
 バッファのセット
 
virtual void release ()
 Publisher を破棄する。
 

限定公開メンバ関数

void onSend (ByteData &data)
 ON_SENDのリスナへ通知する。
 
void onReceived (ByteData &data)
 ON_RECEIVEDのリスナへ通知する。
 
void onReceiverFull (ByteData &data)
 ON_RECEIVER_FULLのリスナへ通知する。
 
void onReceiverTimeout (ByteData &data)
 ON_RECEIVER_TIMEOUTのリスナへ通知する。
 
void onReceiverError (ByteData &data)
 ON_RECEIVER_ERRORのリスナへ通知する。
 

詳解

PublisherFlush クラス

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

構築子と解体子

◆ PublisherFlush()

RTC::PublisherFlush::PublisherFlush ( )

コンストラクタ

◆ ~PublisherFlush()

RTC::PublisherFlush::~PublisherFlush ( )
override

デストラクタ

関数詳解

◆ activate()

DataPortStatus RTC::PublisherFlush::activate ( )
overridevirtual

アクティブ化する

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

◆ deactivate()

DataPortStatus RTC::PublisherFlush::deactivate ( )
overridevirtual

非アクティブ化する

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

◆ init()

DataPortStatus RTC::PublisherFlush::init ( coil::Properties &  prop)
overridevirtual

初期化

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

◆ isActive()

bool RTC::PublisherFlush::isActive ( )
overridevirtual

アクティブ化確認

Publisher はデータポートと同期して activate/deactivate される。 activate() / deactivate() 関数によって、アクティブ状態と非アクティ ブ状態が切り替わる。この関数により、現在アクティブ状態か、非アク ティブ状態かを確認することができる。

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

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

◆ onReceived()

void RTC::PublisherFlush::onReceived ( ByteData data)
inlineprotected

ON_RECEIVEDのリスナへ通知する。

参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVED.

◆ onReceiverError()

void RTC::PublisherFlush::onReceiverError ( ByteData data)
inlineprotected

ON_RECEIVER_ERRORのリスナへ通知する。

参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVER_ERROR.

◆ onReceiverFull()

void RTC::PublisherFlush::onReceiverFull ( ByteData data)
inlineprotected

ON_RECEIVER_FULLのリスナへ通知する。

参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVER_FULL.

◆ onReceiverTimeout()

void RTC::PublisherFlush::onReceiverTimeout ( ByteData data)
inlineprotected

ON_RECEIVER_TIMEOUTのリスナへ通知する。

参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_RECEIVER_TIMEOUT.

◆ onSend()

void RTC::PublisherFlush::onSend ( ByteData data)
inlineprotected

ON_SENDのリスナへ通知する。

参照先 RTC::ConnectorListenersBase::notifyOut(), RTC::ON_SEND.

◆ setBuffer()

DataPortStatus RTC::PublisherFlush::setBuffer ( CdrBufferBase buffer)
override

バッファのセット

◆ setConsumer()

DataPortStatus RTC::PublisherFlush::setConsumer ( InPortConsumer consumer)
overridevirtual

InPortコンシューマのセット

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

◆ setListener()

::RTC::DataPortStatus RTC::PublisherFlush::setListener ( ConnectorInfo info,
RTC::ConnectorListenersBase listeners 
)
overridevirtual

リスナを設定する。

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

◆ write()

DataPortStatus RTC::PublisherFlush::write ( ByteDataStreamBase data,
std::chrono::nanoseconds  timeout = std::chrono::nanoseconds(-1) 
)
overridevirtual

データを書き込む

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


このクラス詳解は次のファイルから抽出されました: