Struct CircularBuffer 

pub struct CircularBuffer { /* private fields */ }

Circular buffer state for pre/post-trigger capture.

Implementations

impl CircularBuffer

pub fn new( pre_count: usize, post_count: usize, condition: TriggerCondition, ) -> Self

pub fn set_preset_trigger_count(&mut self, count: usize)

Set the preset trigger count (0 = unlimited).

pub fn trigger_count(&self) -> usize

C actualTriggerCount — the number of completed capture sequences. Reads one less than the number of triggers fired while a flush is still in progress; C only increments it at the end of the sequence.

pub fn status(&self) -> BufferStatus

Get the current buffer status.

pub fn set_flush_on_soft_trigger(&mut self, flush_on: i32)

Store NDCircBuffFlushOnSoftTrig as written (C setIntegerParam); the value is interpreted only by Self::flushes_on_soft_trigger.

pub fn flushes_on_soft_trigger(&self) -> bool

C NDPluginCircularBuff.cpp:276 — if (flushOn > 0) flushPreBuffer(). The ONLY reader of flush_on_soft_trigger: negative and zero both mean “do not flush”, so a caput FlushOnSoftTrig -1 leaves the pre-buffer to drain lazily with the first post-trigger frame, as in C.

pub fn start(&mut self)

C writeInt32(NDCircBuffControl, 1) (NDPluginCircularBuff.cpp:233-254): rebuild the ring, drop the trigger state, zero the counters, and turn acquisition on. The only way Self::push starts admitting frames.

pub fn stop(&mut self)

C writeInt32(NDCircBuffControl, 0) (NDPluginCircularBuff.cpp:255-260): acquisition off. C clears the trigger latches and the displayed image count but leaves the ring alone, so a restart is a fresh start().

pub fn is_running(&self) -> bool

C scopeControl — is the plugin acquiring? The single gate on admitting a frame, and the same test C’s writeInt32(NDCircBuffPreTrigger) uses to reject a pre-count change (:281-283).

pub fn push(&mut self, array: Arc<NDArray>) -> PushResult

Push an array into the circular buffer.

Mirrors C++ NDPluginCircularBuff::processCallbacks: on the frame that triggers, the pre-buffer is flushed immediately and the triggering frame is forwarded as the first post-trigger frame; each subsequent post-trigger frame is forwarded individually. The returned PushResult::forward holds the frames to send downstream this call.

pub fn trigger(&mut self)

External trigger.

pub fn take_captured(&mut self) -> Vec<Arc<NDArray>>

Take the captured arrays (pre + post trigger).

pub fn is_triggered(&self) -> bool

pub fn pre_buffer_len(&self) -> usize

pub fn reset(&mut self)

Drop the ring and every counter. Leaves acquisition OFF — start() is the one entry point that turns it on.