クラス RTC::InPortConsumer

#include <InPortConsumer.h>

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

構成
struct	publishInterfaceProfileFunc
	インターフェースプロファイルを公開するたのファンクタ [詳細]
struct	subscribeInterfaceFunc
	インターフェースプロファイルを公開するたのファンクタ [詳細]
Public メソッド
virtual DATAPORTSTATUS_ENUM	~InPortConsumer (void)
virtual void	init (coil::Properties &prop)=0
	設定初期化
virtual ReturnCode	put (const cdrMemoryStream &data)=0
	接続先へのデータ送信
virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)=0
	InterfaceProfile情報を公開する.
virtual bool	subscribeInterface (const SDOPackage::NVList &properties)=0
	データ送出通知受け取りへの登録
virtual void	unsubscribeInterface (const SDOPackage::NVList &properties)=0
	データ送出通知受け取りからの登録解除

説明

InPortConsumer 抽象クラス.

入力ポートコンシューマのための抽象インターフェースクラス各具象クラスは、以下の純粋仮想関数の実装を提供しなければならない。

push(): データ送信
clone(): ポートのコピー
subscribeInterface(): データ送出通知への登録
unsubscribeInterface(): データ送出通知の登録解除

から:: 0.4.0

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

virtual DATAPORTSTATUS_ENUM RTC::InPortConsumer::~InPortConsumer ( void ) [inline, virtual]

デストラクタ

関数

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

設定初期化

InPortConsumerの各種設定を行う

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

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

InterfaceProfile情報を公開する.

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

引数:

properties

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

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

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

virtual ReturnCode RTC::InPortConsumer::put ( const cdrMemoryStream & data ) [pure virtual]

接続先へのデータ送信

接続先のポートへデータを送信するための純粋仮想関数。

この関数は、以下のリターンコードを返す。

PORT_OK: 正常終了。
PORT_ERROR: データ送信の過程で何らかのエラーが発生した。
SEND_FULL: データを送信したが、相手側バッファがフルだった。
SEND_TIMEOUT: データを送信したが、相手側バッファがタイムアウトした。
CONNECTION_LOST: 接続が切断された
UNKNOWN_ERROR: 原因不明のエラー

引数:

data

送信するデータ

戻り値:: リターンコード

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

virtual bool RTC::InPortConsumer::subscribeInterface ( const SDOPackage::NVList & properties ) [pure virtual]

データ送出通知受け取りへの登録

指定されたプロパティの内容に基づいて、データ送出通知の受け取りに登録するための純粋仮想関数。

引数:

properties

登録時に参照するプロパティ

戻り値:: 登録処理結果

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

参照元 RTC::InPortConsumer::subscribeInterfaceFunc::operator()().

virtual void RTC::InPortConsumer::unsubscribeInterface ( const SDOPackage::NVList & properties ) [pure virtual]

データ送出通知受け取りからの登録解除

データ送出通知の受け取りから登録解除するための純粋仮想関数。

引数:

properties

登録解除時に参照するプロパティ

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

クラス RTC::InPortConsumer

構成

Public メソッド

説明

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

関数