OpenRTM-aist  1.2.2
公開メンバ関数 | 限定公開変数類 | 全メンバ一覧
RTC::OutPortSHMConsumer クラス

OutPortSHMConsumer クラス [詳解]

#include <OutPortSHMConsumer.h>

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

公開メンバ関数

DATAPORTSTATUS_ENUM OutPortSHMConsumer ()
 コンストラクタ [詳解]
 
virtual ~OutPortSHMConsumer ()
 デストラクタ [詳解]
 
virtual void init (coil::Properties &prop)
 設定初期化 [詳解]
 
virtual void setBuffer (CdrBufferBase *buffer)
 バッファをセットする [詳解]
 
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 リスナを設定する。 [詳解]
 
virtual ReturnCode get (cdrMemoryStream &data)
 データを読み出す [詳解]
 
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 データ受信通知への登録 [詳解]
 
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 データ受信通知からの登録解除 [詳解]
 
virtual bool setObject (CORBA::Object_ptr obj)
 オブジェクトをセットする [詳解]
 
- 基底クラス RTC::OutPortConsumer に属する継承公開メンバ関数
virtual DATAPORTSTATUS_ENUM ~OutPortConsumer (void)
 デストラクタ [詳解]
 
- 基底クラス RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory > に属する継承公開メンバ関数
 CorbaConsumer ()
 コンストラクタ [詳解]
 
 CorbaConsumer (const CorbaConsumer &x)
 コピーコンストラクタ [詳解]
 
CorbaConsumer & operator= (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)
 コピーコンストラクタ [詳解]
 
CorbaConsumerBase & operator= (const CorbaConsumerBase &x)
 代入演算子 [詳解]
 
void swap (CorbaConsumerBase &x)
 swap関数 [詳解]
 
virtual ~CorbaConsumerBase (void)
 仮想デストラクタ [詳解]
 
virtual CORBA::Object_ptr getObject ()
 CORBAオブジェクトを取得する [詳解]
 

限定公開変数類

coil::Mutex m_mutex
 
Logger rtclog
 
SharedMemoryPort m_shmem
 
CdrBufferBase * m_buffer
 
ConnectorListeners * m_listeners
 
ConnectorInfo m_profile
 
- 基底クラス RTC::OutPortConsumer に属する継承限定公開変数類
Logger rtclog
 ロガーストリーム [詳解]
 
- 基底クラス RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory > に属する継承限定公開変数類
typename ::OpenRTM::PortSharedMemory ::_var_type m_var
 設定された CORBA オブジェクト [詳解]
 
- 基底クラス RTC::CorbaConsumerBase に属する継承限定公開変数類
CORBA::Object_var m_objref
 設定された CORBA オブジェクト [詳解]
 

その他の継承メンバ

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

詳解

OutPortSHMConsumer クラス

OutPortConsumer

通信手段に 共有メモリ を利用した出力ポートプロバイダーの実装クラス。

から
0.4.0

構築子と解体子

◆ OutPortSHMConsumer()

DATAPORTSTATUS_ENUM RTC::OutPortSHMConsumer::OutPortSHMConsumer ( )

コンストラクタ

コンストラクタ

◆ ~OutPortSHMConsumer()

virtual RTC::OutPortSHMConsumer::~OutPortSHMConsumer ( )
virtual

デストラクタ

デストラクタ

関数詳解

◆ get()

virtual ReturnCode RTC::OutPortSHMConsumer::get ( cdrMemoryStream &  data)
virtual

データを読み出す

設定されたデータを読み出す。

引数
data読み出したデータを受け取るオブジェクト
戻り値
データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)

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

◆ init()

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

設定初期化

引数
prop設定情報

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

◆ setBuffer()

virtual void RTC::OutPortSHMConsumer::setBuffer ( CdrBufferBase *  buffer)
virtual

バッファをセットする

引数
bufferOutPortProviderがデータを取り出すバッファへのポインタ

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

◆ setListener()

virtual void RTC::OutPortSHMConsumer::setListener ( ConnectorInfo &  info,
ConnectorListeners *  listeners 
)
virtual

リスナを設定する。

引数
info接続情報
listenersリスナオブジェクト

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

◆ setObject()

virtual bool RTC::OutPortSHMConsumer::setObject ( CORBA::Object_ptr  obj)
virtual

オブジェクトをセットする

ConsumerBase のオーバーライド。CORBA::Object_var にオブジェクトをセット するとともに、templateパラメータの型で narrow したオブジェクトを メンバ変数に保持する。 _var 型変数を引数に渡す場合は var.in() を渡すこと。

引数
[in]objCORBA Objecct
戻り値
オブジェクト設定結果 設定対象オブジェクトが null の場合は false が返ってくる

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

◆ subscribeInterface()

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

データ受信通知への登録

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

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

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

◆ unsubscribeInterface()

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

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

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

引数
properties登録解除情報

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

メンバ詳解

◆ m_buffer

CdrBufferBase* RTC::OutPortSHMConsumer::m_buffer
protected

◆ m_listeners

ConnectorListeners* RTC::OutPortSHMConsumer::m_listeners
protected

◆ m_mutex

coil::Mutex RTC::OutPortSHMConsumer::m_mutex
protected

◆ m_profile

ConnectorInfo RTC::OutPortSHMConsumer::m_profile
protected

◆ m_shmem

SharedMemoryPort RTC::OutPortSHMConsumer::m_shmem
protected

◆ rtclog

Logger RTC::OutPortSHMConsumer::rtclog
mutableprotected
このクラス詳解は次のファイルから抽出されました:
構築:   doxygen 1.8.13