OpenRTM-aist  1.2.1
クラス | 公開メンバ関数 | 全メンバ一覧
RTC::InPortConsumer クラスabstract

InPortConsumer 抽象クラス [詳解]

#include <InPortConsumer.h>

RTC::InPortConsumer の継承関係図
Inheritance graph
[凡例]
RTC::InPortConsumer 連携図
Collaboration graph
[凡例]

クラス

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

公開メンバ関数

virtual DATAPORTSTATUS_ENUM ~InPortConsumer (void)
 デストラクタ [詳解]
 
virtual void init (coil::Properties &prop)=0
 設定初期化 [詳解]
 
virtual ReturnCode put (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
 データ送出通知受け取りからの登録解除 [詳解]
 

その他の継承メンバ

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

詳解

InPortConsumer 抽象クラス

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

から
0.4.0

構築子と解体子

virtual DATAPORTSTATUS_ENUM RTC::InPortConsumer::~InPortConsumer ( void  )
inlinevirtual

デストラクタ

デストラクタ

関数詳解

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

設定初期化

InPortConsumerの各種設定を行う

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

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

InterfaceProfile情報を公開する

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

引数
propertiesInterfaceProfile情報を受け取るプロパティ

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

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

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

接続先へのデータ送信

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

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

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

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

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

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

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

引数
properties登録時に参照するプロパティ
戻り値
登録処理結果

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

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

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

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

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

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

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

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