SharedMemory クラス [詳解]

#include <SharedMemory.h>

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

virtual	~SharedMemory ()
	デストラクタ [詳解]

	SharedMemory (const SharedMemory &rhs)
	コピーコンストラクタ [詳解]

SharedMemory &	operator= (const SharedMemory &rhs)
	代入演算子 [詳解]

virtual int	create (std::string shm_address, int memory_size=DEFAULT_MEMORY_SIZE)
	共有メモリの生成。 [詳解]

virtual int	open (std::string shm_address, int memory_size=DEFAULT_MEMORY_SIZE)
	共有メモリへのアクセス。 [詳解]

virtual int	write (const char *data, const int pos, const int size)
	共有メモリへの書き込み。 [詳解]

virtual int	read (char *data, const int pos, const int size)
	共有メモリからの読み込み。 [詳解]

virtual int	close ()
	共有メモリの削除。 [詳解]

virtual unsigned int	get_size ()
	メモリのサイズ取得。 [詳解]

virtual std::string	get_addresss ()
	メモリのアドレス取得。 [詳解]

virtual char *	get_data ()
	メモリの取得 [詳解]

virtual int	unlink ()
	ファイル削除(Windowsの場合は何もしない) [詳解]

virtual bool	created ()
	共有メモリに生成済みかの確認 [詳解]

詳解

SharedMemory クラス

構築子と解体子

coil::SharedMemory::SharedMemory ( )

コンストラクタ

コンストラクタ。

virtual coil::SharedMemory::~SharedMemory ( )

virtual

デストラクタ

デストラクタ。

coil::SharedMemory::SharedMemory ( const SharedMemory & rhs )

コピーコンストラクタ

コピーコンストラクタ。

引数

rhs	コピー元共有メモリオブジェクト

関数詳解

virtual int coil::SharedMemory::close ( )

virtual

共有メモリの削除。

戻り値: 0: 成功, -1: 失敗

virtual int coil::SharedMemory::create	(	std::string	shm_address,
		int	memory_size = `DEFAULT_MEMORY_SIZE`
	)

virtual

共有メモリの生成。

引数

shm_address	共有メモリの識別子
memory_size	共有メモリのサイズ

戻り値: 0: 成功, -1: 失敗

virtual bool coil::SharedMemory::created ( )

virtual

共有メモリに生成済みかの確認

戻り値: true: 作成済み,false: 未作成

virtual std::string coil::SharedMemory::get_addresss ( )

virtual

メモリのアドレス取得。

戻り値: アドレス

virtual char* coil::SharedMemory::get_data ( )

virtual

メモリの取得

戻り値: メモリ

virtual unsigned int coil::SharedMemory::get_size ( )

virtual

メモリのサイズ取得。

戻り値: サイズ

virtual int coil::SharedMemory::open	(	std::string	shm_address,
		int	memory_size = `DEFAULT_MEMORY_SIZE`
	)

virtual

共有メモリへのアクセス。

引数

shm_address 共有メモリの識別子

戻り値: 0: 成功, -1: 失敗

SharedMemory& coil::SharedMemory::operator= ( const SharedMemory & rhs )

代入演算子

共有メモリオブジェクトをコピーする。

引数

rhs	代入元動的共有メモリオブジェクト

戻り値: 代入結果

virtual int coil::SharedMemory::read	(	char *	data,
		const int	pos,
		const int	size
	)

virtual

共有メモリからの読み込み。

引数

data 読み込むデータ

戻り値: 0: 成功, -1: 失敗

virtual int coil::SharedMemory::unlink ( )

virtual

ファイル削除(Windowsの場合は何もしない)

戻り値: 0: 成功, -1: 失敗

virtual int coil::SharedMemory::write	(	const char *	data,
		const int	pos,
		const int	size
	)

virtual

共有メモリへの書き込み。

引数

data 書き込むデータ

戻り値: 0: 成功, -1: 失敗

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

/home/openrtm/doc-build/OpenRTM-aist-1.2.1/src/lib/coil/include/coil/SharedMemory.h

公開メンバ関数

詳解

構築子と解体子

関数詳解