#include <OutPortSHMConsumer.h>

RTC::OutPortSHMConsumer の継承関係図

[凡例]

RTC::OutPortSHMConsumer 連携図

[凡例]

公開メンバ関数
	OutPortSHMConsumer ()
	コンストラクタ [詳解]

	~OutPortSHMConsumer () override
	デストラクタ [詳解]

void	init (coil::Properties &prop) override
	設定初期化 [詳解]

void	setBuffer (CdrBufferBase *buffer) override
	バッファをセットする [詳解]

void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	リスナを設定する。 [詳解]

DataPortStatus	get (ByteData &data) override
	データを読み出す [詳解]

bool	subscribeInterface (const SDOPackage::NVList &properties) override
	データ受信通知への登録 [詳解]

void	unsubscribeInterface (const SDOPackage::NVList &properties) override
	データ受信通知からの登録解除 [詳解]

bool	setObject (CORBA::Object_ptr obj) override
	CORBAオブジェクトをセットする [詳解]

基底クラス RTC::OutPortConsumer に属する継承公開メンバ関数
virtual	~OutPortConsumer ()=default
	デストラクタ [詳解]

virtual void	init (coil::Properties &prop)=0
	設定初期化 [詳解]

virtual void	setBuffer (CdrBufferBase *buffer)=0
	バッファをセットする [詳解]

virtual void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners)=0
	リスナを設定する。 [詳解]

virtual DataPortStatus	get (ByteData &data)=0
	データを受信する [詳解]

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オブジェクトの設定をクリアする [詳解]

限定公開変数類
Logger	rtclog

coil::Properties	m_properties

std::mutex	m_mutex

std::string	m_shm_address

SharedMemoryPort	m_shmem

int	m_memory_size

bool	m_endian

CdrBufferBase *	m_buffer

ConnectorListenersBase *	m_listeners {nullptr}

ConnectorInfo	m_profile

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

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

詳解

OutPortSHMConsumer クラス

OutPortConsumer

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

から: 0.4.0

構築子と解体子

◆ OutPortSHMConsumer()

RTC::OutPortSHMConsumer::OutPortSHMConsumer ( )

コンストラクタ

◆ ~OutPortSHMConsumer()

RTC::OutPortSHMConsumer::~OutPortSHMConsumer ( )

override

デストラクタ

関数詳解

◆ get()

DataPortStatus RTC::OutPortSHMConsumer::get ( ByteData & data )

overridevirtual

データを読み出す

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

引数

data	読み出したデータを受け取るオブジェクト

戻り値: データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)

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

◆ init()

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

overridevirtual

設定初期化

引数

prop 設定情報

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

◆ setBuffer()

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

overridevirtual

バッファをセットする

引数

buffer OutPortProviderがデータを取り出すバッファへのポインタ

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

◆ setListener()

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

overridevirtual

リスナを設定する。

引数

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

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

◆ setObject()

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

overridevirtual

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

与えられたオブジェクトリファレンスは、ConsumerBase オブジェクト内に CORBA::Object_var 型として保持される。 _var 型変数を引数に渡す場合は var.in() を渡すこと。

引数

obj	CORBA オブジェクトのリファレンス

戻り値: obj が nil リファレンスの場合 false を返す。

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

◆ subscribeInterface()

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

overridevirtual

データ受信通知への登録

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

引数

properties 登録情報

戻り値: 登録処理結果(登録成功:true、登録失敗:false)

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

◆ unsubscribeInterface()

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

overridevirtual

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

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

引数

properties 登録解除情報

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

メンバ詳解

◆ m_buffer

CdrBufferBase* RTC::OutPortSHMConsumer::m_buffer

protected

◆ m_endian

bool RTC::OutPortSHMConsumer::m_endian

protected

◆ m_listeners

ConnectorListenersBase* RTC::OutPortSHMConsumer::m_listeners {nullptr}

protected

◆ m_memory_size

int RTC::OutPortSHMConsumer::m_memory_size

protected

◆ m_mutex

std::mutex RTC::OutPortSHMConsumer::m_mutex

protected

◆ m_profile

ConnectorInfo RTC::OutPortSHMConsumer::m_profile

protected

◆ m_properties

coil::Properties RTC::OutPortSHMConsumer::m_properties

protected

◆ m_shm_address

std::string RTC::OutPortSHMConsumer::m_shm_address

protected

◆ m_shmem

SharedMemoryPort RTC::OutPortSHMConsumer::m_shmem

protected

◆ rtclog

Logger RTC::OutPortSHMConsumer::rtclog

mutableprotected

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

OutPortSHMConsumer.h

公開メンバ関数

限定公開変数類

詳解

構築子と解体子

◆ OutPortSHMConsumer()

◆ ~OutPortSHMConsumer()

関数詳解

◆ get()

◆ init()

◆ setBuffer()

◆ setListener()

◆ setObject()

◆ subscribeInterface()

◆ unsubscribeInterface()

メンバ詳解

◆ m_buffer

◆ m_endian

◆ m_listeners

◆ m_memory_size

◆ m_mutex

◆ m_profile

◆ m_properties

◆ m_shm_address

◆ m_shmem

◆ rtclog