RTC::InPortSHMConsumer クラス

InPortSHMConsumer クラス [詳解]

#include <InPortSHMConsumer.h>

RTC::InPortSHMConsumer の継承関係図

RTC::InPortSHMConsumer 連携図

公開メンバ関数
	InPortSHMConsumer ()
	コンストラクタ [詳解]
	~InPortSHMConsumer () override
	デストラクタ [詳解]
void	init (coil::Properties &prop) override
	設定初期化 [詳解]
DataPortStatus	put (ByteData &data) override
	接続先へのデータ送信 [詳解]
bool	setObject (CORBA::Object_ptr obj) 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< ::OpenRTM::PortSharedMemory > に属する継承公開メンバ関数
	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オブジェクトの設定をクリアする [詳解]

静的限定公開メンバ関数
static DataPortStatus	convertReturnCode (OpenRTM::PortStatus ret)

限定公開変数類
coil::Properties	m_properties
std::mutex	m_mutex
std::string	m_shm_address
SharedMemoryPort	m_shmem
int	m_memory_size {0}
bool	m_endian {true}
Logger	rtclog {"InPortSHMConsumer"}
基底クラス RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory > に属する継承限定公開変数類
typename ObjectType::_var_type	m_var
	設定された CORBA オブジェクト [詳解]
基底クラス RTC::CorbaConsumerBase に属する継承限定公開変数類
CORBA::Object_var	m_objref
	設定された CORBA オブジェクト [詳解]

詳解

InPortSHMConsumer クラス

InPortConsumer

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

から

1.2.0

構築子と解体子

InPortSHMConsumer()

RTC::InPortSHMConsumer::InPortSHMConsumer

(

)

コンストラクタ

コンストラクタ

引数

buffer

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

~InPortSHMConsumer()

RTC::InPortSHMConsumer::~InPortSHMConsumer ( )

override

デストラクタ

デストラクタ

関数詳解

convertReturnCode()

static DataPortStatus RTC::InPortSHMConsumer::convertReturnCode ( OpenRTM::PortStatus  ret )

staticprotected

init()

void RTC::InPortSHMConsumer::init ( coil::Properties &  prop )

overridevirtual

設定初期化

引数

prop

設定情報

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

publishInterfaceProfile()

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

overridevirtual

InterfaceProfile情報を公開する

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

引数

properties

InterfaceProfile情報を受け取るプロパティ

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

put()

DataPortStatus RTC::InPortSHMConsumer::put ( ByteData &  data )

overridevirtual

接続先へのデータ送信

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

引数

data

送信するデータ

戻り値

リターンコード

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

setObject()

bool RTC::InPortSHMConsumer::setObject ( CORBA::Object_ptr  obj )

overridevirtual

RTC::CorbaConsumerBaseを再実装しています。

subscribeInterface()

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

overridevirtual

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

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

引数

properties

登録時に参照するプロパティ

戻り値

登録処理結果

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

unsubscribeInterface()

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

overridevirtual

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

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

引数

properties

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

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

メンバ詳解

m_endian

bool RTC::InPortSHMConsumer::m_endian {true}

protected

m_memory_size

int RTC::InPortSHMConsumer::m_memory_size {0}

protected

m_mutex

std::mutex RTC::InPortSHMConsumer::m_mutex

protected

m_properties

coil::Properties RTC::InPortSHMConsumer::m_properties

protected

m_shm_address

std::string RTC::InPortSHMConsumer::m_shm_address

protected

m_shmem

SharedMemoryPort RTC::InPortSHMConsumer::m_shmem

protected

rtclog

Logger RTC::InPortSHMConsumer::rtclog {"InPortSHMConsumer"}

mutableprotected

---

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

• InPortSHMConsumer.h