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

#include <ConnectorListener.h>

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

公開メンバ関数

virtual ~ConnectorListenersBase ()
 デストラクタ
 
virtual::RTC::ConnectorListenerStatus::Enum notifyIn (ConnectorDataListenerType type, ConnectorInfo &info, ByteData &data)=0
 リスナーへ通知する(InPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 InPort側ではnotifyOut関数を使用する必要がある。
 
virtual::RTC::ConnectorListenerStatus::Enum notifyOut (ConnectorDataListenerType type, ConnectorInfo &info, ByteData &data)=0
 リスナーへ通知する(OutPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 OutPort側ではnotifyOut関数を使用する必要がある。
 
virtual::RTC::ConnectorListenerStatus::Enum notify (ConnectorListenerType type, ConnectorInfo &info)=0
 リスナーへ通知する
 
virtual bool addListener (ConnectorDataListenerType type, ConnectorDataListener *listener, bool autoclean=true)=0
 リスナーの追加
 
virtual bool addListener (ConnectorListenerType type, ConnectorListener *listener, bool autoclean=true)=0
 リスナーの追加
 
virtual bool removeListener (ConnectorDataListenerType type, ConnectorDataListener *listener)=0
 リスナーの削除
 
virtual bool removeListener (ConnectorListenerType type, ConnectorListener *listener)=0
 リスナーの削除
 
virtual ConnectorDataListenerHolder * getDataListenerHolder (ConnectorDataListenerType type)=0
 指定の種類のConnectorDataListenerHolderを取得する
 
template<class DataType >
::RTC::ConnectorListenerStatus::Enum notifyIn (ConnectorDataListenerType type, ConnectorInfo &info, DataType &data)
 リスナーへ通知する(データ型指定、InPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 InPort側ではnotifyOut関数を使用する必要がある。
 
template<class DataType >
::RTC::ConnectorListenerStatus::Enum notifyOut (ConnectorDataListenerType type, ConnectorInfo &info, DataType &data)
 リスナーへ通知する(データ型指定、OutPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 OutPort側ではnotifyOut関数を使用する必要がある。
 

構築子と解体子

◆ ~ConnectorListenersBase()

virtual RTC::ConnectorListenersBase::~ConnectorListenersBase ( )
virtual

デストラクタ

関数詳解

◆ addListener() [1/2]

virtual bool RTC::ConnectorListenersBase::addListener ( ConnectorDataListenerType type,
ConnectorDataListener * listener,
bool autoclean = true )
pure virtual

リスナーの追加

指定の種類のConnectorDataListenerを追加する。

引数
typeリスナの種類
listener追加するリスナ
autocleantrue:デストラクタで削除する, false:デストラクタで削除しない
戻り値
false：指定の種類のリスナが存在しない

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

◆ addListener() [2/2]

virtual bool RTC::ConnectorListenersBase::addListener ( ConnectorListenerType type,
ConnectorListener * listener,
bool autoclean = true )
pure virtual

リスナーの追加

指定の種類のConnectorListenerを追加する。

引数
typeリスナの種類
listener追加するリスナ
autocleantrue:デストラクタで削除する, false:デストラクタで削除しない
戻り値
false：指定の種類のリスナが存在しない

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

◆ getDataListenerHolder()

virtual ConnectorDataListenerHolder * RTC::ConnectorListenersBase::getDataListenerHolder ( ConnectorDataListenerType type)
pure virtual

指定の種類のConnectorDataListenerHolderを取得する

引数
typeリスナの種類
戻り値
ConnectorDataListenerHolder

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

参照元 notifyIn(), notifyOut().

◆ notify()

virtual::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notify ( ConnectorListenerType type,
ConnectorInfo & info )
pure virtual

リスナーへ通知する

データポートの Connector において発生する各種イベントに対するコー ルバックメソッド

引数
typeリスナの種類
infoConnectorInfo
戻り値
リターンコード

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

参照元 RTC::InPortConnector::getDirectData(), RTC::InPortPushConnector::onBufferEmpty(), RTC::PublisherPeriodic::onBufferEmpty(), RTC::InPortPushConnector::onBufferReadTimeout(), RTC::PublisherPeriodic::onSenderEmpty(), RTC::PublisherNew::onSenderError(), RTC::PublisherPeriodic::onSenderError().

◆ notifyIn() [1/2]

virtual::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyIn ( ConnectorDataListenerType type,
ConnectorInfo & info,
ByteData & data )
pure virtual

リスナーへ通知する(InPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 InPort側ではnotifyOut関数を使用する必要がある。

引数
typeリスナの種類
infoConnectorInfo
dataバイト列のデータ
戻り値
リターンコード

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

参照元 RTC::InPortConnector::getDirectData(), RTC::InPortPushConnector::onBufferRead(), RTC::OutPortConnector::write().

◆ notifyIn() [2/2]

template<class DataType >
::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyIn ( ConnectorDataListenerType type,
ConnectorInfo & info,
DataType & data )
inline

リスナーへ通知する(データ型指定、InPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 InPort側ではnotifyOut関数を使用する必要がある。

引数
typeリスナの種類
infoConnectorInfo
dataデータ(型指定)
戻り値
リターンコード

参照先 getDataListenerHolder(), RTC::ConnectorListenerStatus::NO_CHANGE, RTC::ConnectorDataListenerHolder::notifyIn().

◆ notifyOut() [1/2]

virtual::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyOut ( ConnectorDataListenerType type,
ConnectorInfo & info,
ByteData & data )
pure virtual

リスナーへ通知する(OutPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 OutPort側ではnotifyOut関数を使用する必要がある。

引数
typeリスナの種類
infoConnectorInfo
dataバイト列のデータ
戻り値
リターンコード

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

参照元 RTC::InPortConnector::getDirectData(), RTC::PublisherNew::onBufferFull(), RTC::PublisherPeriodic::onBufferFull(), RTC::PublisherNew::onBufferRead(), RTC::PublisherPeriodic::onBufferRead(), RTC::PublisherNew::onBufferWrite(), RTC::PublisherPeriodic::onBufferWrite(), RTC::PublisherNew::onBufferWriteOverwrite(), RTC::PublisherNew::onBufferWriteTimeout(), RTC::PublisherPeriodic::onBufferWriteTimeout(), RTC::PublisherFlush::onReceived(), RTC::PublisherNew::onReceived(), RTC::PublisherPeriodic::onReceived(), RTC::PublisherFlush::onReceiverError(), RTC::PublisherNew::onReceiverError(), RTC::PublisherPeriodic::onReceiverError(), RTC::PublisherFlush::onReceiverFull(), RTC::PublisherNew::onReceiverFull(), RTC::PublisherPeriodic::onReceiverFull(), RTC::PublisherFlush::onReceiverTimeout(), RTC::PublisherNew::onReceiverTimeout(), RTC::PublisherPeriodic::onReceiverTimeout(), RTC::PublisherFlush::onSend(), RTC::PublisherNew::onSend(), RTC::PublisherPeriodic::onSend(), RTC::OutPortConnector::write() (計26項目).

◆ notifyOut() [2/2]

template<class DataType >
::RTC::ConnectorListenerStatus::Enum RTC::ConnectorListenersBase::notifyOut ( ConnectorDataListenerType type,
ConnectorInfo & info,
DataType & data )
inline

リスナーへ通知する(データ型指定、OutPort側) 指定の種類のリスナのコールバックメソッドを呼び出す。 InPortとOutPortでシリアライザの種類が違う場合があるため、 OutPort側ではnotifyOut関数を使用する必要がある。

引数
typeリスナの種類
infoConnectorInfo
dataデータ(型指定)
戻り値
リターンコード

参照先 getDataListenerHolder(), RTC::ConnectorListenerStatus::NO_CHANGE, RTC::ConnectorDataListenerHolder::notifyOut().

◆ removeListener() [1/2]

virtual bool RTC::ConnectorListenersBase::removeListener ( ConnectorDataListenerType type,
ConnectorDataListener * listener )
pure virtual

リスナーの削除

指定の種類のConnectorDataListenerを削除する。

引数
typeリスナの種類
listener削除するリスナ
戻り値
false：指定の種類のリスナが存在しない

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

◆ removeListener() [2/2]

virtual bool RTC::ConnectorListenersBase::removeListener ( ConnectorListenerType type,
ConnectorListener * listener )
pure virtual

リスナーの削除

指定の種類のConnectorListenerを削除する。

引数
typeリスナの種類
listener削除するリスナ
戻り値
false：指定の種類のリスナが存在しない

RTC::ConnectorListeners, RTC::ConnectorListenersT< DataType >で実装されています。

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