#include <InPortDirectProvider.h>

RTC::InPortDirectProvider の継承関係図

RTC::InPortDirectProvider 連携図

[凡例]

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

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

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

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

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

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

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

virtual	~InPortProvider (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::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
	ロガーストリーム [詳解]

詳解

InPortDirectProvider クラス

InPortProvider

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

から: 0.4.0

構築子と解体子

RTC::InPortDirectProvider::InPortDirectProvider ( void )

コンストラクタ

virtual RTC::InPortDirectProvider::~InPortDirectProvider ( void )

virtual

デストラクタ

関数詳解

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

virtual

設定初期化

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

引数

prop 設定情報

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

virtual void RTC::InPortDirectProvider::setBuffer ( BufferBase< cdrMemoryStream > * buffer )

virtual

バッファをセットする

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

引数

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

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

virtual void RTC::InPortDirectProvider::setConnector ( InPortConnector * connector )

virtual

Connectorを設定する。

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

引数

connector InPortConnector

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

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

virtual

リスナを設定する。

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

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を実装しています。

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

InPortDirectProvider.h

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

関数詳解