#include <OutPortCorbaCdrProvider.h>

RTC::OutPortCorbaCdrProvider の継承関係図

RTC::OutPortCorbaCdrProvider 連携図

[凡例]

公開メンバ関数
	OutPortCorbaCdrProvider (void)
	コンストラクタ [詳解]

virtual	~OutPortCorbaCdrProvider (void)
	デストラクタ [詳解]

virtual void	init (coil::Properties &prop)
	設定初期化 [詳解]

virtual void	setBuffer (CdrBufferBase *buffer)
	バッファをセットする [詳解]

virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	リスナを設定する。 [詳解]

virtual void	setConnector (OutPortConnector *connector)
	Connectorを設定する。 [詳解]

virtual ::OpenRTM::PortStatus	get (::OpenRTM::CdrData_out data) throw (CORBA::SystemException)
	[CORBA interface] バッファからデータを取得する [詳解]

基底クラス RTC::OutPortProvider に属する継承公開メンバ関数
virtual DATAPORTSTATUS_ENUM	~OutPortProvider (void)
	デストラクタ [詳解]

virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)
	InterfaceProfile情報を公開する [詳解]

virtual bool	publishInterface (SDOPackage::NVList &properties)
	Interface情報を公開する [詳解]

その他の継承メンバ
基底クラス RTC::DataPortStatus に属する継承公開型
enum	Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR }

基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char *	toString (DataPortStatus::Enum status)
	DataPortStatus リターンコードを文字列に変換 [詳解]

基底クラス 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

構築子と解体子

RTC::OutPortCorbaCdrProvider::OutPortCorbaCdrProvider ( void )

コンストラクタ

virtual RTC::OutPortCorbaCdrProvider::~OutPortCorbaCdrProvider ( void )

virtual

デストラクタ

関数詳解

virtual ::OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::get	(	::OpenRTM::CdrData_out	data	)
throw	(	CORBA::SystemException
	)

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

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

戻り値: 取得データ

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

virtual

設定初期化

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

引数

prop 設定情報

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

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

virtual

バッファをセットする

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

引数

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

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

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

virtual

Connectorを設定する。

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

引数

connector OutPortConnector

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

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

virtual

リスナを設定する。

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

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

関数詳解