RTC::OutPortCorbaCdrProvider クラス

OutPortCorbaCdrProvider クラス [詳解]

#include <OutPortCorbaCdrProvider.h>

RTC::OutPortCorbaCdrProvider の継承関係図

RTC::OutPortCorbaCdrProvider 連携図

公開メンバ関数
	OutPortCorbaCdrProvider ()
	コンストラクタ
	~OutPortCorbaCdrProvider () override
	デストラクタ
void	init (coil::Properties &prop) override
	設定初期化
void	setBuffer (CdrBufferBase *buffer) override
	バッファをセットする
void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	リスナを設定する。
void	setConnector (OutPortConnector *connector) override
	Connectorを設定する。
::OpenRTM::PortStatus	get (::OpenRTM::CdrData_out data) override
	[CORBA interface] バッファからデータを取得する
基底クラス RTC::OutPortProvider に属する継承公開メンバ関数
virtual	~OutPortProvider ()
	デストラクタ
virtual void	publishInterfaceProfile (SDOPackage::NVList &prop)
	InterfaceProfile情報を公開する
virtual bool	publishInterface (SDOPackage::NVList &prop)
	Interface情報を公開する

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

詳解

OutPortCorbaCdrProvider クラス

OutPortProvider

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

から

0.4.0

構築子と解体子

OutPortCorbaCdrProvider()

RTC::OutPortCorbaCdrProvider::OutPortCorbaCdrProvider

(

)

コンストラクタ

コンストラクタ

~OutPortCorbaCdrProvider()

RTC::OutPortCorbaCdrProvider::~OutPortCorbaCdrProvider ( )

override

デストラクタ

デストラクタ

関数詳解

get()

::OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::get ( ::OpenRTM::CdrData_out data )

override

[CORBA interface] バッファからデータを取得する

設定された内部バッファからデータを取得する。

戻り値

取得データ

init()

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

overridevirtual

設定初期化

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

引数

prop

設定情報

RTC::OutPortProviderを再実装しています。

setBuffer()

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

overridevirtual

バッファをセットする

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

引数

buffer

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

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

setConnector()

void RTC::OutPortCorbaCdrProvider::setConnector ( OutPortConnector * connector )

overridevirtual

Connectorを設定する。

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

引数

connector

OutPortConnector

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

setListener()

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

overridevirtual

リスナを設定する。

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

• ON_BUFFER_READ
• ON_SEND
• ON_BUFFER_EMPTY
• ON_BUFFER_READ_TIMEOUT
• ON_SENDER_EMPTY
• ON_SENDER_TIMEOUT
• ON_SENDER_ERROR

引数

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

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

---

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

• OutPortCorbaCdrProvider.h