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

InPortSHMConsumer クラス [詳解]

#include <InPortSHMConsumer.h>

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

公開メンバ関数

DATAPORTSTATUS_ENUM InPortSHMConsumer ()
 コンストラクタ [詳解]
 
virtual ~InPortSHMConsumer ()
 デストラクタ [詳解]
 
virtual void init (coil::Properties &prop)
 設定初期化 [詳解]
 
virtual InPortConsumer::ReturnCode put (cdrMemoryStream &data)
 接続先へのデータ送信 [詳解]
 
virtual bool setObject (CORBA::Object_ptr obj)
 
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::CorbaConsumer< ::OpenRTM::PortSharedMemory > に属する継承公開メンバ関数
 CorbaConsumer ()
 コンストラクタ [詳解]
 
 CorbaConsumer (const CorbaConsumer &x)
 コピーコンストラクタ [詳解]
 
CorbaConsumeroperator= (const CorbaConsumer &x)
 代入演算子 [詳解]
 
void swap (CorbaConsumer &x)
 
virtual ~CorbaConsumer (void)
 仮想デストラクタ [詳解]
 
typename::OpenRTM::PortSharedMemory::_ptr_type _ptr ()
 ObjectType 型のオブジェクトのリファレンスを取得 [詳解]
 
typename::OpenRTM::PortSharedMemory::_ptr_type operator-> ()
 ObjectType 型のオブジェクトのリファレンスを取得 [詳解]
 
virtual void releaseObject ()
 CORBAオブジェクトの設定をクリアする [詳解]
 
- 基底クラス RTC::CorbaConsumerBase に属する継承公開メンバ関数
 CorbaConsumerBase ()
 コンストラクタ [詳解]
 
 CorbaConsumerBase (const CorbaConsumerBase &x)
 コピーコンストラクタ [詳解]
 
CorbaConsumerBaseoperator= (const CorbaConsumerBase &x)
 代入演算子 [詳解]
 
void swap (CorbaConsumerBase &x)
 swap関数 [詳解]
 
virtual ~CorbaConsumerBase (void)
 仮想デストラクタ [詳解]
 
virtual CORBA::Object_ptr getObject ()
 CORBAオブジェクトを取得する [詳解]
 

限定公開メンバ関数

InPortConsumer::ReturnCode convertReturnCode (OpenRTM::PortStatus ret)
 

その他の継承メンバ

- 基底クラス 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 リターンコードを文字列に変換 [詳解]
 
- 基底クラス RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory > に属する継承限定公開変数類
typename::OpenRTM::PortSharedMemory::_var_type m_var
 設定された CORBA オブジェクト [詳解]
 
- 基底クラス RTC::CorbaConsumerBase に属する継承限定公開変数類
CORBA::Object_var m_objref
 設定された CORBA オブジェクト [詳解]
 

詳解

InPortSHMConsumer クラス

InPortConsumer

通信手段に 共有メモリ を利用した入力ポートコンシューマの実装クラス。

から
1.2.0

構築子と解体子

DATAPORTSTATUS_ENUM RTC::InPortSHMConsumer::InPortSHMConsumer ( )

コンストラクタ

コンストラクタ

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

デストラクタ

デストラクタ

関数詳解

InPortConsumer::ReturnCode RTC::InPortSHMConsumer::convertReturnCode ( OpenRTM::PortStatus  ret)
protected
virtual void RTC::InPortSHMConsumer::init ( coil::Properties prop)
virtual

設定初期化

引数
prop設定情報

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

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

InterfaceProfile情報を公開する

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

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

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

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

接続先へのデータ送信

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

引数
data送信するデータ
戻り値
リターンコード

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

virtual bool RTC::InPortSHMConsumer::setObject ( CORBA::Object_ptr  obj)
virtual
引数
obj
戻り値

RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >を再実装しています。

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

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

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

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

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

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

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

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

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

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


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