RTC::InPortDirectConsumer クラス

InPortDirectConsumer クラス [詳解]

#include <InPortDirectConsumer.h>

RTC::InPortDirectConsumer の継承関係図

RTC::InPortDirectConsumer 連携図

公開メンバ関数
	InPortDirectConsumer ()
	コンストラクタ
	~InPortDirectConsumer () override
	デストラクタ
void	init (coil::Properties &prop) override
	設定初期化
DataPortStatus	put (ByteData &data) override
	接続先へのデータ送信
void	publishInterfaceProfile (SDOPackage::NVList &properties) override
	InterfaceProfile情報を公開する
bool	subscribeInterface (const SDOPackage::NVList &properties) override
	データ送信通知への登録
void	unsubscribeInterface (const SDOPackage::NVList &properties) override
	データ送信通知からの登録解除
基底クラス RTC::InPortConsumer に属する継承公開メンバ関数
virtual	~InPortConsumer ()=default
	デストラクタ

詳解

InPortDirectConsumer クラス

InPortConsumer

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

から

0.4.0

構築子と解体子

InPortDirectConsumer()

RTC::InPortDirectConsumer::InPortDirectConsumer

(

)

コンストラクタ

コンストラクタ

引数

buffer

当該コンシューマに割り当てるバッファオブジェクト

~InPortDirectConsumer()

RTC::InPortDirectConsumer::~InPortDirectConsumer ( )

override

デストラクタ

デストラクタ

関数詳解

init()

void RTC::InPortDirectConsumer::init ( coil::Properties & prop )

overridevirtual

設定初期化

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

引数

prop

設定情報

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

publishInterfaceProfile()

void RTC::InPortDirectConsumer::publishInterfaceProfile ( SDOPackage::NVList & properties )

overridevirtual

InterfaceProfile情報を公開する

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

引数

properties

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

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

put()

DataPortStatus RTC::InPortDirectConsumer::put ( ByteData & data )

overridevirtual

接続先へのデータ送信

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

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

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

引数

data

送信するデータ

戻り値

リターンコード

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

subscribeInterface()

bool RTC::InPortDirectConsumer::subscribeInterface ( const SDOPackage::NVList & properties )

overridevirtual

データ送信通知への登録

指定されたプロパティに基づいて、データ送出通知の受け取りに登録する。

引数

properties

登録情報

戻り値

登録処理結果(登録成功:true、登録失敗:false)

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

unsubscribeInterface()

void RTC::InPortDirectConsumer::unsubscribeInterface ( const SDOPackage::NVList & properties )

overridevirtual

データ送信通知からの登録解除

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

引数

properties

登録解除情報

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

---

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

• InPortDirectConsumer.h