#include <OutPortDSConsumer.h>

RTC::OutPortDSConsumer の継承関係図

[凡例]

RTC::OutPortDSConsumer 連携図

[凡例]

公開メンバ関数
	OutPortDSConsumer ()
	コンストラクタ

	~OutPortDSConsumer () override
	デストラクタ

void	init (coil::Properties &prop) override
	設定初期化

void	setBuffer (CdrBufferBase *buffer) override
	バッファをセットする

void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	リスナを設定する。

DataPortStatus	get (ByteData &data) override
	データを読み出す

bool	subscribeInterface (const SDOPackage::NVList &properties) override
	データ受信通知への登録

void	unsubscribeInterface (const SDOPackage::NVList &properties) override
	データ受信通知からの登録解除

基底クラス RTC::OutPortConsumer に属する継承公開メンバ関数
virtual	~OutPortConsumer ()=default
	デストラクタ

基底クラス RTC::CorbaConsumer< ::RTC::DataPullService > に属する継承公開メンバ関数
	CorbaConsumer ()
	コンストラクタ

	CorbaConsumer (const CorbaConsumer &x)
	コピーコンストラクタ

CorbaConsumer &	operator= (const CorbaConsumer &x)
	代入演算子

void	swap (CorbaConsumer &x)

	~CorbaConsumer () override
	仮想デストラクタ

bool	setObject (CORBA::Object_ptr obj) override
	オブジェクトをセットする

typename ::RTC::DataPullService::_ptr_type	_ptr ()
	ObjectType 型のオブジェクトのリファレンスを取得

typename ::RTC::DataPullService::_ptr_type	operator-> ()
	ObjectType 型のオブジェクトのリファレンスを取得

void	releaseObject () override
	CORBAオブジェクトの設定をクリアする

基底クラス RTC::CorbaConsumerBase に属する継承公開メンバ関数
	CorbaConsumerBase ()=default
	コンストラクタ

	CorbaConsumerBase (const CorbaConsumerBase &x)
	コピーコンストラクタ

CorbaConsumerBase &	operator= (const CorbaConsumerBase &x)
	代入演算子

void	swap (CorbaConsumerBase &x)
	swap関数

virtual	~CorbaConsumerBase ()
	仮想デストラクタ

virtual CORBA::Object_ptr	getObject ()
	CORBAオブジェクトを取得する

その他の継承メンバ
基底クラス RTC::OutPortConsumer に属する継承限定公開変数類
Logger	rtclog
	ロガーストリーム

基底クラス RTC::CorbaConsumer< ::RTC::DataPullService > に属する継承限定公開変数類
typename ::RTC::DataPullService::_var_type	m_var
	設定された CORBA オブジェクト

基底クラス RTC::CorbaConsumerBase に属する継承限定公開変数類
CORBA::Object_var	m_objref
	設定された CORBA オブジェクト

詳解

OutPortDSConsumer クラス

OutPortConsumer

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

から: 2.0.0

構築子と解体子

◆ OutPortDSConsumer()

RTC::OutPortDSConsumer::OutPortDSConsumer ( )

コンストラクタ

◆ ~OutPortDSConsumer()

RTC::OutPortDSConsumer::~OutPortDSConsumer ( )

override

デストラクタ

関数詳解

◆ get()

DataPortStatus RTC::OutPortDSConsumer::get ( ByteData & data )

overridevirtual

データを読み出す

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

引数

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

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

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

◆ init()

void RTC::OutPortDSConsumer::init ( coil::Properties & prop )

overridevirtual

設定初期化

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

引数

prop 設定情報

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

◆ setBuffer()

void RTC::OutPortDSConsumer::setBuffer ( CdrBufferBase * buffer )

overridevirtual

バッファをセットする

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

引数

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

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

◆ setListener()

void RTC::OutPortDSConsumer::setListener	(	ConnectorInfo &	info,
		ConnectorListenersBase *	listeners )

overridevirtual

リスナを設定する。

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

ON_BUFFER_WRITE
ON_BUFFER_FULL
ON_RECEIVED
ON_RECEIVER_FULL
ON_SENDER_EMPTY
ON_SENDER_TIMEOUT
ON_SENDER_ERROR

引数

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

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

◆ subscribeInterface()

bool RTC::OutPortDSConsumer::subscribeInterface ( const SDOPackage::NVList & properties )

overridevirtual

データ受信通知への登録

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

引数

properties 登録情報

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

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

◆ unsubscribeInterface()

void RTC::OutPortDSConsumer::unsubscribeInterface ( const SDOPackage::NVList & properties )

overridevirtual

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

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

引数

properties 登録解除情報

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

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

OutPortDSConsumer.h

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ OutPortDSConsumer()

◆ ~OutPortDSConsumer()

関数詳解

◆ get()

◆ init()

◆ setBuffer()

◆ setListener()

◆ subscribeInterface()

◆ unsubscribeInterface()