クラス RTC::OutPortCorbaCdrConsumer

#include <OutPortCorbaCdrConsumer.h>

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

Public メソッド
DATAPORTSTATUS_ENUM	OutPortCorbaCdrConsumer ()
virtual	~OutPortCorbaCdrConsumer (void)
virtual void	init (coil::Properties &prop)
	設定初期化
virtual void	setBuffer (CdrBufferBase *buffer)
	バッファをセットする
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	リスナを設定する。
virtual ReturnCode	get (cdrMemoryStream &data)
	データを読み出す
virtual bool	subscribeInterface (const SDOPackage::NVList &properties)
	データ受信通知への登録
virtual void	unsubscribeInterface (const SDOPackage::NVList &properties)
	データ受信通知からの登録解除

説明

OutPortCorbaCdrConsumer クラス.

OutPortConsumer

データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用した、pull 型データフロー型を実現する OutPort コンシューマクラス。

から:: 0.4.0

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

DATAPORTSTATUS_ENUM RTC::OutPortCorbaCdrConsumer::OutPortCorbaCdrConsumer ( )

コンストラクタ

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

デストラクタ

関数

virtual ReturnCode RTC::OutPortCorbaCdrConsumer::get ( cdrMemoryStream & data ) [virtual]

データを読み出す

設定されたデータを読み出す。

引数:

data

読み出したデータを受け取るオブジェクト

戻り値:: データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)

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

virtual void RTC::OutPortCorbaCdrConsumer::init ( coil::Properties & prop ) [virtual]

設定初期化

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

引数:

prop

設定情報

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

virtual void RTC::OutPortCorbaCdrConsumer::setBuffer ( CdrBufferBase * buffer ) [virtual]

バッファをセットする

OutPortConsumerがデータを取り出すバッファをセットする。すでにセットされたバッファがある場合、以前のバッファへのポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、バッファの削除はユーザの責任で行わなければならない。

引数:

buffer

OutPortProviderがデータを取り出すバッファへのポインタ

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

virtual void RTC::OutPortCorbaCdrConsumer::setListener	(	ConnectorInfo &	info,
		ConnectorListeners *	listeners
	)			`[virtual]`

リスナを設定する。

InPort はデータ送信処理における各種イベントに対して特定のリスナオブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortCorbaCdrProvider では、以下のコールバックが提供される。

ON_BUFFER_WRITE
ON_BUFFER_FULL
ON_RECEIVED
ON_RECEIVER_FULL
ON_SENDER_EMPTY
ON_SENDER_TIMEOUT
ON_SENDER_ERROR

引数:

	info	接続情報
	listeners	リスナオブジェクト

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

virtual bool RTC::OutPortCorbaCdrConsumer::subscribeInterface ( const SDOPackage::NVList & properties ) [virtual]

データ受信通知への登録

指定されたプロパティに基づいて、データ受信通知の受け取りに登録する。

引数:

properties

登録情報

戻り値:: 登録処理結果(登録成功:true、登録失敗:false)

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

virtual void RTC::OutPortCorbaCdrConsumer::unsubscribeInterface ( const SDOPackage::NVList & properties ) [virtual]

データ受信通知からの登録解除

データ受信通知の受け取りから登録を解除する。

引数:

properties

登録解除情報

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

クラス RTC::OutPortCorbaCdrConsumer

Public メソッド

説明

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

関数