RTC::InPortDSProvider クラス

InPortDSProvider クラス [詳解]

#include <InPortDSProvider.h>

RTC::InPortDSProvider の継承関係図

RTC::InPortDSProvider 連携図

公開メンバ関数
	InPortDSProvider ()
	コンストラクタ
	~InPortDSProvider () override
	デストラクタ
void	init (coil::Properties &prop) override
	設定初期化
void	setBuffer (BufferBase< ByteData > *buffer) override
	バッファをセットする
void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	リスナを設定する。
void	setConnector (InPortConnector *connector) override
	Connectorを設定する。
::RTC::PortStatus	push (const ::RTC::OctetSeq &data) override
	[CORBA interface] バッファにデータを書き込む
基底クラス RTC::InPortProvider に属する継承公開メンバ関数
	InPortProvider ()
	コンストラクタ
virtual	~InPortProvider ()
	デストラクタ
virtual void	publishInterfaceProfile (SDOPackage::NVList &prop)
	InterfaceProfile情報を公開する
virtual bool	publishInterface (SDOPackage::NVList &prop)
	Interface情報を公開する

その他の継承メンバ
基底クラス RTC::InPortProvider に属する継承限定公開メンバ関数
void	setInterfaceType (const char *interface_type)
	インタフェースタイプを設定する
void	setDataFlowType (const char *dataflow_type)
	データフロータイプを設定する
void	setSubscriptionType (const char *subs_type)
	サブスクリプションタイプを設定する
基底クラス RTC::InPortProvider に属する継承限定公開変数類
SDOPackage::NVList	m_properties
	ポートプロファイルを保持するプロパティ
Logger	rtclog
	ロガーストリーム

詳解

InPortDSProvider クラス

InPortProvider

データ転送に CORBA の RTC::DataPushService インターフェースを利用し た、push 型データフロー型を実現する InPort プロバイダクラス。

から

2.0.0

構築子と解体子

InPortDSProvider()

RTC::InPortDSProvider::InPortDSProvider

(

)

コンストラクタ

コンストラクタ

~InPortDSProvider()

RTC::InPortDSProvider::~InPortDSProvider ( )

override

デストラクタ

デストラクタ

関数詳解

init()

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

overridevirtual

設定初期化

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

引数

prop

設定情報

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

push()

::RTC::PortStatus RTC::InPortDSProvider::push ( const ::RTC::OctetSeq & data )

override

[CORBA interface] バッファにデータを書き込む

設定されたバッファにデータを書き込む。

引数

data

書込対象データ

setBuffer()

void RTC::InPortDSProvider::setBuffer ( BufferBase< ByteData > * buffer )

overridevirtual

バッファをセットする

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

引数

buffer

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

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

setConnector()

void RTC::InPortDSProvider::setConnector ( InPortConnector * connector )

overridevirtual

Connectorを設定する。

InPort は接続確立時に InPortConnector オブジェクトを生成し、生 成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は InPort が保持するので InPortProvider は InPortConnector を削 除してはいけない。

引数

connector

InPortConnector

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

setListener()

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

overridevirtual

リスナを設定する。

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

• ON_BUFFER_WRITE
• ON_BUFFER_FULL
• ON_BUFFER_WRITE_TIMEOUT
• ON_BUFFER_OVERWRITE
• ON_RECEIVED
• ON_RECEIVER_FULL
• ON_RECEIVER_FULL
• ON_RECEIVER_TIMEOUT
• ON_RECEIVER_ERROR

引数

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

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

---

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

• InPortDSProvider.h