RTC::OutPortSHMProvider クラス

OutPortSHMProvider クラス [詳解]

#include <OutPortSHMProvider.h>

RTC::OutPortSHMProvider の継承関係図

RTC::OutPortSHMProvider 連携図

公開メンバ関数
	OutPortSHMProvider ()
	コンストラクタ
	~OutPortSHMProvider () override
	デストラクタ
void	init (coil::Properties &prop) override
	設定初期化
void	setBuffer (CdrBufferBase *buffer) override
	バッファをセットする
void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	リスナを設定する。
void	setConnector (OutPortConnector *connector) override
	Connectorを設定する。
::OpenRTM::PortStatus	get () override
	[CORBA interface] バッファからデータを取得する
基底クラス RTC::OutPortProvider に属する継承公開メンバ関数
virtual	~OutPortProvider ()
	デストラクタ
virtual void	publishInterfaceProfile (SDOPackage::NVList &prop)
	InterfaceProfile情報を公開する
virtual bool	publishInterface (SDOPackage::NVList &prop)
	Interface情報を公開する
基底クラス RTC::SharedMemoryPort に属する継承公開メンバ関数
	SharedMemoryPort ()
	コンストラクタ
	~SharedMemoryPort () override
	デストラクタ
virtual int	string_to_MemorySize (std::string size_str)
	文字列で指定したデータサイズを数値に変換する 1M → 1048576 1k → 1024 100 → 100
void	create_memory (::CORBA::ULongLong memory_size, const char *shm_address) override
	共有メモリの初期化 windowsではページングファイル上に領域を確保する Linuxでは/dev/shm以下にファイルを作成する 作成したファイルの内容を仮想アドレスにマッピングする
void	open_memory (::CORBA::ULongLong memory_size, const char *shm_address) override
	共有メモリのマッピングを行う
void	close_memory (::CORBA::Boolean unlink=false) override
	マッピングした共有メモリをアンマップする
virtual void	write (ByteData &data)
	データを書き込む 先頭8byteにデータサイズを書き込み、その後ろにデータを書き込む 設定したデータサイズが共有メモリのサイズを上回った場合、共有メモリの初期化を行う
virtual void	read (ByteData &data)
	データを読み込む
void	setInterface (::OpenRTM::PortSharedMemory_ptr sm) override
	通信先のCORBAインターフェースを登録する 登録する事により共有メモリの初期化したときに、通信先でもマッピングをやり直すことができる
void	setEndian (::CORBA::Boolean endian) override
	エンディアンを設定する
::OpenRTM::PortStatus	put () override
	データの送信を知らせる
::OpenRTM::PortStatus	get () override
	データの送信を要求する
virtual::OpenRTM::PortSharedMemory_ptr	getObjRef ()

その他の継承メンバ
基底クラス RTC::OutPortProvider に属する継承限定公開メンバ関数
void	setPortType (const char *port_type)
	ポートタイプを設定する
void	setDataType (const char *data_type)
	データタイプを設定する
void	setInterfaceType (const char *interface_type)
	インターフェースタイプを設定する
void	setDataFlowType (const char *dataflow_type)
	データフロータイプを設定する
void	setSubscriptionType (const char *subs_type)
	サブスクリプションタイプを設定する
基底クラス RTC::OutPortProvider に属する継承限定公開変数類
SDOPackage::NVList	m_properties
	ポートプロファイルを保持するプロパティ
Logger	rtclog
	ロガーストリーム
基底クラス RTC::SharedMemoryPort に属する継承限定公開変数類
::OpenRTM::PortSharedMemory_var	m_smInterface {OpenRTM::PortSharedMemory::_nil()}
bool	m_endian {true}
coil::SharedMemory	m_shmem

詳解

OutPortSHMProvider クラス

OutPortProvider

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

から

1.2.0

構築子と解体子

OutPortSHMProvider()

RTC::OutPortSHMProvider::OutPortSHMProvider

(

)

コンストラクタ

コンストラクタ

~OutPortSHMProvider()

RTC::OutPortSHMProvider::~OutPortSHMProvider ( )

override

デストラクタ

デストラクタ

関数詳解

get()

::OpenRTM::PortStatus RTC::OutPortSHMProvider::get ( )

override

[CORBA interface] バッファからデータを取得する

設定された内部バッファからデータを取得する。

戻り値

取得データ

init()

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

overridevirtual

設定初期化

引数

prop

設定情報

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

setBuffer()

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

overridevirtual

バッファをセットする

引数

buffer

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

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

setConnector()

void RTC::OutPortSHMProvider::setConnector ( OutPortConnector * connector )

overridevirtual

Connectorを設定する。

引数

connector

OutPortConnector

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

setListener()

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

overridevirtual

リスナを設定する。

引数

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

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

---

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

• OutPortSHMProvider.h