クラス RTC::InPortProvider

#include <InPortProvider.h>

RTC::InPortProviderに対する継承グラフ

構成
struct	publishInterfaceFunc
	インターフェースプロファイルを公開するたのファンクタ [詳細]
struct	publishInterfaceProfileFunc
	インターフェースプロファイルを公開するたのファンクタ [詳細]
Public メソッド
DATAPORTSTATUS_ENUM	InPortProvider ()
virtual	~InPortProvider (void)
	デストラクタ
virtual void	init (coil::Properties &prop)=0
	設定初期化
virtual void	setBuffer (BufferBase< cdrMemoryStream > *buffer)=0
	バッファをセットする
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0
	リスナを設定する。
virtual void	setConnector (InPortConnector *connector)=0
	Connectorを設定する。.
virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)
	InterfaceProfile情報を公開する.
virtual bool	publishInterface (SDOPackage::NVList &properties)
	Interface情報を公開する.
Protected メソッド
void	setInterfaceType (const char *interface_type)
	インタフェースタイプを設定する
void	setDataFlowType (const char *dataflow_type)
	データフロータイプを設定する
void	setSubscriptionType (const char *subs_type)
	サブスクリプションタイプを設定する
Protected 変数
SDOPackage::NVList	m_properties
	ポートプロファイルを保持するプロパティ
Logger	rtclog
	ロガーストリーム

コンストラクタとデストラクタ

DATAPORTSTATUS_ENUM RTC::InPortProvider::InPortProvider ( )

コンストラクタ

virtual RTC::InPortProvider::~InPortProvider ( void ) [virtual]

デストラクタ

仮想デストラクタ

関数

virtual void RTC::InPortProvider::init ( coil::Properties & prop ) [pure virtual]

設定初期化

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

引数:

prop

設定情報

RTC::InPortCorbaCdrProviderで実装されています。

virtual bool RTC::InPortProvider::publishInterface ( SDOPackage::NVList & properties ) [virtual]

Interface情報を公開する.

Interface情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトのdataport.interface_type 値を調べ、当該ポートに設定されていなければNameValue に情報を追加する。すでに同一インターフェースが登録済みの場合は何も行わない。

引数:

properties

Interface情報を受け取るプロパティ

戻り値:: true: 正常終了

参照元 RTC::InPortProvider::publishInterfaceFunc::operator()().

virtual void RTC::InPortProvider::publishInterfaceProfile ( SDOPackage::NVList & properties ) [virtual]

InterfaceProfile情報を公開する.

InterfaceProfile情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されているインターフェースタイプと一致する場合のみ情報を取得する。

引数:

properties

InterfaceProfile情報を受け取るプロパティ

参照元 RTC::InPortProvider::publishInterfaceProfileFunc::operator()().

virtual void RTC::InPortProvider::setBuffer ( BufferBase< cdrMemoryStream > * buffer ) [pure virtual]

バッファをセットする

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

引数:

buffer

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

RTC::InPortCorbaCdrProviderで実装されています。

virtual void RTC::InPortProvider::setConnector ( InPortConnector * connector ) [pure virtual]

Connectorを設定する。.

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

引数:

connector

OutPortConnector

RTC::InPortCorbaCdrProviderで実装されています。

void RTC::InPortProvider::setDataFlowType ( const char * dataflow_type ) [protected]

データフロータイプを設定する

データフロータイプを設定する。

引数:

dataflow_type

設定対象データフロータイプ

void RTC::InPortProvider::setInterfaceType ( const char * interface_type ) [protected]

インタフェースタイプを設定する

インタフェースタイプを設定する。

引数:

interface_type

設定対象インタフェースタイプ

virtual void RTC::InPortProvider::setListener	(	ConnectorInfo &	info,
		ConnectorListeners *	listeners
	)			`[pure virtual]`

リスナを設定する。

OutPort はデータ送信処理における各種イベントに対して特定のリスナオブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortProvider のサブクラスでは、与えられたリスナを適切なタイミングで呼び出すべきである。ただし、すべてのリスナを呼び出す必要はない。

引数:

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

RTC::InPortCorbaCdrProviderで実装されています。

void RTC::InPortProvider::setSubscriptionType ( const char * subs_type ) [protected]

サブスクリプションタイプを設定する

サブスクリプションタイプを設定する。

引数:

subs_type

設定対象サブスクリプションタイプ

変数

SDOPackage::NVList RTC::InPortProvider::m_properties [protected]

ポートプロファイルを保持するプロパティ

Logger RTC::InPortProvider::rtclog [mutable, protected]

ロガーストリーム

クラス RTC::InPortProvider

構成

Public メソッド

Protected メソッド

Protected 変数

コンストラクタとデストラクタ

関数

変数