#include <InPortConsumer.h>

RTC::InPortConsumer の継承関係図

[凡例]

クラス
struct	publishInterfaceProfileFunc
	インターフェースプロファイルを公開するたのファンクタ [詳解]

struct	subscribeInterfaceFunc
	インターフェースプロファイルを公開するたのファンクタ [詳解]

公開メンバ関数
virtual	~InPortConsumer ()=default
	デストラクタ

virtual void	init (coil::Properties &prop)=0
	設定初期化

virtual DataPortStatus	put (ByteData &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

構築子と解体子

◆ ~InPortConsumer()

virtual RTC::InPortConsumer::~InPortConsumer ( )

virtualdefault

デストラクタ

関数詳解

◆ init()

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

pure virtual

設定初期化

InPortConsumerの各種設定を行う

RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, RTC::InPortSHMConsumerで実装されています。

◆ publishInterfaceProfile()

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

pure virtual

InterfaceProfile情報を公開する

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

引数

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

RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, RTC::InPortSHMConsumerで実装されています。

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

◆ put()

virtual DataPortStatus RTC::InPortConsumer::put ( ByteData & data )

pure virtual

接続先へのデータ送信

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

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

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

引数

data 送信するデータ

戻り値: リターンコード

RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, RTC::InPortSHMConsumerで実装されています。

◆ subscribeInterface()

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

pure virtual

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

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

引数

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

戻り値: 登録処理結果

RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, RTC::InPortSHMConsumerで実装されています。

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

◆ unsubscribeInterface()

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

pure virtual

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

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

引数

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

RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, RTC::InPortSHMConsumerで実装されています。

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

InPortConsumer.h

クラス

公開メンバ関数

詳解

構築子と解体子

◆ ~InPortConsumer()

関数詳解

◆ init()

◆ publishInterfaceProfile()

◆ put()

◆ subscribeInterface()

◆ unsubscribeInterface()