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

Publisher 基底クラス [詳解]

#include <PublisherBase.h>

RTC::PublisherBase の継承関係図
Inheritance graph
[凡例]

公開メンバ関数

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

詳解

Publisher 基底クラス

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

から
0.4.0

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

から
0.4.0

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

から
0.4.0

構築子と解体子

◆ ~PublisherBase()

virtual RTC::PublisherBase::~PublisherBase ( )
virtualdefault

デストラクタ

関数詳解

◆ activate()

virtual DataPortStatus RTC::PublisherBase::activate ( )
pure virtual

アクティブ化する

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

◆ deactivate()

virtual DataPortStatus RTC::PublisherBase::deactivate ( )
pure virtual

非アクティブ化する

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

◆ init()

virtual DataPortStatus RTC::PublisherBase::init ( coil::Properties &  prop)
pure virtual

設定初期化

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

◆ isActive()

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

アクティブ化確認

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

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

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

◆ release()

virtual void RTC::PublisherBase::release ( )
inlinevirtual

Publisher を破棄する。

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

◆ setBuffer()

virtual DataPortStatus RTC::PublisherBase::setBuffer ( BufferBase< ByteData > *  buffer)
pure virtual

バッファのセット

◆ setConsumer()

virtual DataPortStatus RTC::PublisherBase::setConsumer ( InPortConsumer consumer)
pure virtual

InPortコンシューマのセット

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

◆ setListener()

virtual DataPortStatus RTC::PublisherBase::setListener ( ConnectorInfo info,
ConnectorListenersBase listeners 
)
pure virtual

リスナを設定する。

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

◆ write()

virtual DataPortStatus RTC::PublisherBase::write ( ByteDataStreamBase data,
std::chrono::nanoseconds  timeout 
)
pure virtual

データを書き込む

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


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