#include <InPortDirectConsumer.h>

RTC::InPortDirectConsumer の継承関係図

RTC::InPortDirectConsumer 連携図

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

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

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

virtual ReturnCode	put (cdrMemoryStream &data)
	接続先へのデータ送信 [詳解]

virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)
	InterfaceProfile情報を公開する [詳解]

virtual bool	subscribeInterface (const SDOPackage::NVList &properties)
	データ送信通知への登録 [詳解]

virtual void	unsubscribeInterface (const SDOPackage::NVList &properties)
	データ送信通知からの登録解除 [詳解]

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

その他の継承メンバ
基底クラス 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 リターンコードを文字列に変換 [詳解]

詳解

InPortDirectConsumer クラス

InPortConsumer

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

から: 0.4.0

構築子と解体子

DATAPORTSTATUS_ENUM RTC::InPortDirectConsumer::InPortDirectConsumer ( void )

コンストラクタ

引数

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

virtual RTC::InPortDirectConsumer::~InPortDirectConsumer ( void )

virtual

デストラクタ

関数詳解

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

virtual

設定初期化

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

引数

prop 設定情報

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

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

virtual

InterfaceProfile情報を公開する

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

引数

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

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

virtual ReturnCode RTC::InPortDirectConsumer::put ( cdrMemoryStream & data )

virtual

接続先へのデータ送信

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

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

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

引数

data 送信するデータ

戻り値: リターンコード

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

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

virtual

データ送信通知への登録

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

引数

properties 登録情報

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

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

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

virtual

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

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

引数

properties 登録解除情報

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

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

InPortDirectConsumer.h

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

関数詳解