RingBuffer operations on a Device. More...

Inherits IDeviceInterface, IEnumerable< RingBufferImage >, and IDisposable.

Inherited by RingBuffer.

Public Member Functions
int[]	GetAcquisitionSequence ()
	Gets the sequence of ring buffer images in the order they were acquired. More...

void	ChangeCount (int numBuffers, DeviceUpdateMode mode)
	Sets a new ring buffer size in the acquisition engine. More...

Properties
int	Count `[get]`
	Gets the number of buffers in this ring buffer.

RingBufferLockMode	LockMode `[get, set]`
	Gets/sets the current lock mode.

RingBufferImage	this[int bufferIndex] `[get]`
	Gets the ring buffer image at the given bufferIndex . More...

Properties inherited from IDeviceInterface
Device	Parent `[get]`
	The Device this interface works on.

Detailed Description

RingBuffer operations on a Device.

Member Function Documentation

◆ ChangeCount()

void ChangeCount	(	int	numBuffers,
		DeviceUpdateMode	mode
	)

Sets a new ring buffer size in the acquisition engine.

Calling this method is only possible if the acquisition not Stream.IsRunning.

If you are unsure about the mode , simply use DeviceUpdateMode.UpdateDeviceImage.

Parameters

numBuffers	New number of image buffers.
mode	Defines how to handle device images.

◆ GetAcquisitionSequence()

int[] GetAcquisitionSequence ( )

Gets the sequence of ring buffer images in the order they were acquired.

Calling this method gives a snapshot of all acquired images based on the point in time when the last IAcquisition.Wait() or related method was called.

The first entry in the list is thus the oldest waited upon image and the last one is the newest (the one returned by Wait).

Returns: Array of RingBuffer indeces in acquisition order.

Property Documentation

◆ this[int bufferIndex]

RingBufferImage this[int bufferIndex]

get

Gets the ring buffer image at the given bufferIndex .