OpenRTM_aist.SharedMemory.SharedMemory Class Reference

More...

Inheritance diagram for OpenRTM_aist.SharedMemory.SharedMemory:

Public Member Functions
	__init__ (self)
	__del__ (self)
	string_to_MemorySize (self, size_str)
	create_memory (self, memory_size, shm_address)
	open_memory (self, memory_size, shm_address)
	close_memory (self, unlink=False)
	write (self, data)
	read (self)
	setInterface (self, sm)
	setEndian (self, endian)
	put (self)
	get (self)

Detailed Description

SharedMemory class

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.SharedMemory.SharedMemory.__init__

(

self

)

Constructor

Constructor

Parameters

self

Reimplemented in OpenRTM_aist.InPortSHMProvider.InPortSHMProvider, and OpenRTM_aist.OutPortSHMProvider.OutPortSHMProvider.

__del__()

OpenRTM_aist.SharedMemory.SharedMemory.__del__

(

self

)

Destructor

Destructor

Parameters

self

Reimplemented in OpenRTM_aist.InPortSHMProvider.InPortSHMProvider, and OpenRTM_aist.OutPortSHMProvider.OutPortSHMProvider.

Member Function Documentation

close_memory()

OpenRTM_aist.SharedMemory.SharedMemory.close_memory	(		self,
			unlink = False )

Parameters

self
unlink

void close_memory(boolean unlink);

create_memory()

OpenRTM_aist.SharedMemory.SharedMemory.create_memory	(		self,
			memory_size,
			shm_address )

Parameters

memory_size
shm_address

void create_memory(int memory_size, string shm_address);

get()

OpenRTM_aist.SharedMemory.SharedMemory.get

(

self

)

Parameters

self

PortStatus get();

Reimplemented in OpenRTM_aist.OutPortSHMProvider.OutPortSHMProvider.

open_memory()

OpenRTM_aist.SharedMemory.SharedMemory.open_memory	(		self,
			memory_size,
			shm_address )

Parameters

memory_size

@parama shm_address

void open_memory(int memory_size, string shm_address);

put()

OpenRTM_aist.SharedMemory.SharedMemory.put

(

self

)

Parameters

self

PortStatus put();

Reimplemented in OpenRTM_aist.InPortSHMProvider.InPortSHMProvider.

read()

OpenRTM_aist.SharedMemory.SharedMemory.read

(

self

)

Parameters

self

Returns

cdrMemoryStream read(data);

setEndian()

OpenRTM_aist.SharedMemory.SharedMemory.setEndian	(		self,
			endian )

Parameters

self
endian	endian

void setEndian(bool endian);

setInterface()

OpenRTM_aist.SharedMemory.SharedMemory.setInterface	(		self,
			sm )

void setInterface(.OpenRTM.PortSharedMemory_var sm);

string_to_MemorySize()

OpenRTM_aist.SharedMemory.SharedMemory.string_to_MemorySize	(		self,
			size_str )

Parameters

self
size_str

Returns

int string_to_MemorySize(string size_str);

write()

OpenRTM_aist.SharedMemory.SharedMemory.write	(		self,
			data )

Parameters

self
data

void write(const cdrMemoryStream& data);

---

The documentation for this class was generated from the following file:

• SharedMemory.py