PyFoam.Basics.RingBuffer module

A ring-buffer data structure

class PyFoam.Basics.RingBuffer.RingBuffer(nr=1000)

Bases: object

A data structure that stores a number N of elements. The N+1-element overwrites the first and so on ….

__dict__ = mappingproxy({'__module__': 'PyFoam.Basics.RingBuffer', '__doc__': 'A data structure that stores a number N of elements. The\n    N+1-element overwrites the first and so on ....', '__init__': <function RingBuffer.__init__>, 'insert': <function RingBuffer.insert>, 'last': <function RingBuffer.last>, 'dump': <function RingBuffer.dump>, '__dict__': <attribute '__dict__' of 'RingBuffer' objects>, '__weakref__': <attribute '__weakref__' of 'RingBuffer' objects>, '__annotations__': {}})

__init__(nr=1000)

Parameters:

nr – Number of elements to store

__module__ = 'PyFoam.Basics.RingBuffer'

__weakref__

list of weak references to the object (if defined)

dump()

Returns:

A list with all the values in the ring buffer in the correct order

(starting with the oldest)

insert(dings)

Inserts am element into the ring-buffer

last()

Returns:

the latest element in the buffer, None if

nothing was inserted into the buffer