Skip to content

← utilities package

OneSampleBuffer

One sample buffer for control signals.

This is primarily meant to handle default values for multi-channel user-provided control signals that update at most once per tick (i.e., there is only one sample per tick). The initial value of the control signal is sourced from the initi_values argument, and thereafter the initial value is optionally updated based on the data of the input signal. There is a distinct 'null' value, which will not override the default values, to allow users to override the defaults only partially. Version 1.0.0

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
INOUT

initial_values

These values are the initial values assigned to the output. The dict use channel names as the key values.

verbose name
Initial Values
default value
None
port type
DictPort
value type
dict (can be None)

null_value

The null value. If the input signal contains this value in any of its channels, the current value in the buffer will not be updated.

verbose name
Null Value
default value
nan
port type
FloatPort
value type
float (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)