WaveformListLibrary#
- class WaveformListLibrary#
Bases:
MmParameterWaveformListLibrarystores namedWaveformListpresets.Each row defines a waveform list preset with sampling rate and list-level behaviors such as concatenation and patching methods, and holds
WaveformOriginIDs pointing intoWaveformLibrary.Schema (columns, types, defaults):
Column
Type
Default
Name
string
DefaultWaveformList
SamplingRate
double
1000
ConcatMethod
string
Sequential
PatchMethod
string
Continue
PatchConstant
double
0
IsTriggerAdvance
logical
0
NPeriodPerCycle
double
10
WaveformOrigin
doubleMatrix
[]
Foreign keys:
(none)
Join conditions:
(none)
Flags:
Property
Value
IsIncludeDefaultEntry
false
IsFirstColumnUnique
true
IsTriggerJoinOnRight
false
IsTriggerJoinOnLeft
false
- Constructor Summary
- WaveformListLibrary()#
- Method Summary
- defineSchema()#
- duplicateEntry(keyColumnValue, name, keyColumnName)#
Duplicate a row and its
WaveformOriginsubtree.- Parameters:
keyColumnValue (
double) – Source row key valuename (
string) – NewNamefor the duplicated listkeyColumnName (
string, optional) – Key column name (defaultID)
- Returns:
New row ID of the duplicated list
- Return type:
double
- loadEntry(nameOrID)#
Load a
WaveformListobject from the database.Resolves by numeric
IDor stringNameand constructs aWaveformListwith itsWaveformOriginitems instantiated fromWaveformLibrary. Remaining properties are copied from the row.- Parameters:
nameOrID (
double or string) – Row ID or logical name- Returns:
Loaded waveform list (empty if not found)
- Return type:
- saveEntry(wfl)#
Save a
WaveformListobject into the database.Upserts the list row by
Nameand synchronizesWaveformOriginchildren inWaveformLibrary.- Parameters:
wfl (
WaveformList) – Waveform list to persist- Returns:
Row ID of the waveform list
- Return type:
double