OpenRTM_aist.BufferBase.BufferBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.BufferBase.BufferBase:

Public Member Functions
	init (self, prop)
	length (self)
	reset (self)
	wptr (self, n=0)
	advanceWptr (self, n=1, unlock_enable=True)
	put (self, data)
	write (self, value, sec=-1, nsec=-1)
	writable (self)
	full (self)
	rptr (self, n=0)
	advanceRptr (self, n=1, unlock_enable=True)
	get (self)
	read (self, sec=-1, nsec=-1)
	readable (self)
	empty (self)

Detailed Description

BufferBase abstract class

This is the abstract interface class for various Buffer.

Since

0.4.0

Member Function Documentation

advanceRptr()

OpenRTM_aist.BufferBase.BufferBase.advanceRptr	(		self,
			n = 1,
			unlock_enable = True )

Get the buffer length

Pure virtual function to get the buffer length.

Returns

buffer length

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

advanceWptr()

OpenRTM_aist.BufferBase.BufferBase.advanceWptr	(		self,
			n = 1,
			unlock_enable = True )

Get the buffer length

Pure virtual function to get the buffer length.

Returns

buffer length

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

empty()

OpenRTM_aist.BufferBase.BufferBase.empty

(

self

)

Check on whether the buffer is empty.

Pure virtual function to check on whether the buffer is empty.

Returns

True if the buffer is empty, else false.

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

full()

OpenRTM_aist.BufferBase.BufferBase.full

(

self

)

Check on whether the buffer is full.

Pure virtual function to check on whether the buffer is full.

Returns

True if the buffer is full, else false.

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

get()

OpenRTM_aist.BufferBase.BufferBase.get

(

self

)

Get data from the buffer

Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.

length()

OpenRTM_aist.BufferBase.BufferBase.length

(

self

)

Get the buffer length

Returns

buffer length

Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.

put()

OpenRTM_aist.BufferBase.BufferBase.put	(		self,
			data )

Write data into the buffer

Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.

read()

OpenRTM_aist.BufferBase.BufferBase.read	(		self,
			sec = -1,
			nsec = -1 )

Read data from the buffer

Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.

readable()

OpenRTM_aist.BufferBase.BufferBase.readable

(

self

)

Write data into the buffer

Pure virtual function to write data into the buffer.

Parameters

value

Target data to write.

Returns

Result of having written in data (true:Successful, false:Failed)

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

reset()

OpenRTM_aist.BufferBase.BufferBase.reset

(

self

)

Get the buffer length

Pure virtual function to get the buffer length.

Returns

buffer length

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

rptr()

OpenRTM_aist.BufferBase.BufferBase.rptr	(		self,
			n = 0 )

Get the buffer length

Pure virtual function to get the buffer length.

Returns

buffer length

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

wptr()

OpenRTM_aist.BufferBase.BufferBase.wptr	(		self,
			n = 0 )

Get the buffer length

Pure virtual function to get the buffer length.

Returns

buffer length

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

writable()

OpenRTM_aist.BufferBase.BufferBase.writable

(

self

)

Write data into the buffer

Pure virtual function to write data into the buffer.

Parameters

value

Target data to write.

Returns

Result of having written in data (true:Successful, false:Failed)

Reimplemented in OpenRTM_aist.RingBuffer.RingBuffer.

write()

OpenRTM_aist.BufferBase.BufferBase.write	(		self,
			value,
			sec = -1,
			nsec = -1 )

Write data into the buffer

Reimplemented in OpenRTM_aist.BufferBase.NullBuffer, and OpenRTM_aist.RingBuffer.RingBuffer.

---

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

• BufferBase.py