クラス RTC::InPortCorbaCdrConsumer

InPortCorbaCdrConsumer クラス. [詳細]

#include <InPortCorbaCdrConsumer.h>

RTC::InPortCorbaCdrConsumerに対する継承グラフ
RTC::InPortConsumer RTC::CorbaConsumer< ::OpenRTM::InPortCdr > RTC::DataPortStatus RTC::CorbaConsumerBase

すべてのメンバ一覧

Public メソッド

DATAPORTSTATUS_ENUM InPortCorbaCdrConsumer (void)
 コンストラクタ
virtual ~InPortCorbaCdrConsumer (void)
virtual void init (coil::Properties &prop)
 設定初期化
virtual ReturnCode put (const cdrMemoryStream &data)
 接続先へのデータ送信
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 InterfaceProfile情報を公開する.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 データ送信通知への登録
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 データ送信通知からの登録解除

説明

InPortCorbaCdrConsumer クラス.

InPortConsumer

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

から:
0.4.0

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

DATAPORTSTATUS_ENUM RTC::InPortCorbaCdrConsumer::InPortCorbaCdrConsumer ( void   ) 

コンストラクタ

コンストラクタ

引数:
buffer 当該コンシューマに割り当てるバッファオブジェクト
virtual RTC::InPortCorbaCdrConsumer::~InPortCorbaCdrConsumer ( void   )  [virtual]

デストラクタ


関数

virtual void RTC::InPortCorbaCdrConsumer::init ( coil::Properties prop  )  [virtual]

設定初期化

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

引数:
prop 設定情報

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

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

InterfaceProfile情報を公開する.

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

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

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

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

接続先へのデータ送信

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

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

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

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

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

データ送信通知への登録

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

引数:
properties 登録情報
戻り値:
登録処理結果(登録成功:true、登録失敗:false)

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

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

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

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

引数:
properties 登録解除情報

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

OpenRTM-aistに対してFri Oct 28 18:31:16 2016に生成されました。  doxygen 1.6.3