OpenRTM-aist 2.1.0
公開メンバ関数 | 全メンバ一覧
RTC::InPortDSConsumer クラス

InPortDSConsumer クラス [詳解]

#include <InPortDSConsumer.h>

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

公開メンバ関数

 InPortDSConsumer ()
 コンストラクタ [詳解]
 
 ~InPortDSConsumer () 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
 デストラクタ [詳解]
 
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
 データ送出通知受け取りからの登録解除 [詳解]
 
- 基底クラス RTC::CorbaConsumer< ::RTC::DataPushService > に属する継承公開メンバ関数
 CorbaConsumer ()
 コンストラクタ [詳解]
 
 CorbaConsumer (const CorbaConsumer &x)
 コピーコンストラクタ [詳解]
 
CorbaConsumer & operator= (const CorbaConsumer &x)
 代入演算子 [詳解]
 
void swap (CorbaConsumer &x)
 
 ~CorbaConsumer () override
 仮想デストラクタ [詳解]
 
bool setObject (CORBA::Object_ptr obj) override
 オブジェクトをセットする [詳解]
 
typename ObjectType::_ptr_type _ptr ()
 ObjectType 型のオブジェクトのリファレンスを取得 [詳解]
 
typename ObjectType::_ptr_type operator-> ()
 ObjectType 型のオブジェクトのリファレンスを取得 [詳解]
 
void releaseObject () override
 CORBAオブジェクトの設定をクリアする [詳解]
 
- 基底クラス RTC::CorbaConsumerBase に属する継承公開メンバ関数
 CorbaConsumerBase ()=default
 コンストラクタ [詳解]
 
 CorbaConsumerBase (const CorbaConsumerBase &x)
 コピーコンストラクタ [詳解]
 
CorbaConsumerBase & operator= (const CorbaConsumerBase &x)
 代入演算子 [詳解]
 
void swap (CorbaConsumerBase &x)
 swap関数 [詳解]
 
virtual ~CorbaConsumerBase ()
 仮想デストラクタ [詳解]
 
virtual bool setObject (CORBA::Object_ptr obj)
 CORBAオブジェクトをセットする [詳解]
 
virtual CORBA::Object_ptr getObject ()
 CORBAオブジェクトを取得する [詳解]
 
virtual void releaseObject ()
 CORBAオブジェクトの設定をクリアする [詳解]
 

その他の継承メンバ

- 基底クラス RTC::CorbaConsumer< ::RTC::DataPushService > に属する継承限定公開変数類
typename ObjectType::_var_type m_var
 設定された CORBA オブジェクト [詳解]
 
- 基底クラス RTC::CorbaConsumerBase に属する継承限定公開変数類
CORBA::Object_var m_objref
 設定された CORBA オブジェクト [詳解]
 

詳解

InPortDSConsumer クラス

InPortConsumer

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

から
2.0.0

構築子と解体子

◆ InPortDSConsumer()

RTC::InPortDSConsumer::InPortDSConsumer ( )

コンストラクタ

コンストラクタ

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

◆ ~InPortDSConsumer()

RTC::InPortDSConsumer::~InPortDSConsumer ( )
override

デストラクタ

デストラクタ

関数詳解

◆ init()

void RTC::InPortDSConsumer::init ( coil::Properties &  prop)
overridevirtual

設定初期化

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

引数
prop設定情報

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

◆ publishInterfaceProfile()

void RTC::InPortDSConsumer::publishInterfaceProfile ( SDOPackage::NVList &  properties)
overridevirtual

InterfaceProfile情報を公開する

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

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

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

◆ put()

DataPortStatus RTC::InPortDSConsumer::put ( ByteData &  data)
overridevirtual

接続先へのデータ送信

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

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

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

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

◆ subscribeInterface()

bool RTC::InPortDSConsumer::subscribeInterface ( const SDOPackage::NVList &  properties)
overridevirtual

データ送信通知への登録

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

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

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

◆ unsubscribeInterface()

void RTC::InPortDSConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties)
overridevirtual

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

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

引数
properties登録解除情報

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

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