slist
¶
The slist commands module.
These commands are used in the following models: AWG5K, AWG5KC, AWG7K, AWG7KC
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Commands and Queries
- SLISt:NAME? <Index>
- SLISt:SIZE?
- SLISt:SUBSequence:DELete {<subseq_name>|ALL}
- SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt <subseq_name>,<NR1>
- SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? <subseq_name>
- SLISt:SUBSequence:ELEMent[n]:WAVeform[n] <subseq_name>,<wfm_name>
- SLISt:SUBSequence:ELEMent[n]:WAVeform[n]? <subseq_name>
- SLISt:SUBSequence:LENGth <subseq_name>,<NR1>
- SLISt:SUBSequence:LENGth? <subseq_name>
- SLISt:SUBSequence:NEW <subseq_name>,<length>
- SLISt:SUBSequence:TSTamp? <subseq_name>
Slist
¶
Bases: SCPICmdRead
The SLISt command tree.
Usage
- Using the
.query()method will send theSLISt?query. - Using the
.verify(value)method will send theSLISt?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.name: TheSLISt:NAMEcommand..size: TheSLISt:SIZEcommand..subsequence: TheSLISt:SUBSequencecommand tree.
name
property
¶
name: SlistName
Return the SLISt:NAME command.
Description
- The query returns the name of the subsequence corresponding to the specified index in the subsequence list.
Usage
- Using the
.query(argument)method will send theSLISt:NAME? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:NAME? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SLISt:NAME? <Index>
Info
<Index>::=.
size
property
¶
size: SlistSize
Return the SLISt:SIZE command.
Description
- This command returns the number sequences in sequence list.
Usage
- Using the
.query()method will send theSLISt:SIZE?query. - Using the
.verify(value)method will send theSLISt:SIZE?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SLISt:SIZE?
subsequence
property
¶
subsequence: SlistSubsequence
Return the SLISt:SUBSequence command tree.
Usage
- Using the
.query()method will send theSLISt:SUBSequence?query. - Using the
.verify(value)method will send theSLISt:SUBSequence?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.delete: TheSLISt:SUBSequence:DELetecommand..element: TheSLISt:SUBSequence:ELEMent[n]command tree..length: TheSLISt:SUBSequence:LENGthcommand..new: TheSLISt:SUBSequence:NEWcommand..tstamp: TheSLISt:SUBSequence:TSTampcommand.
SlistName
¶
Bases: SCPICmdReadWithArguments
The SLISt:NAME command.
Description
- The query returns the name of the subsequence corresponding to the specified index in the subsequence list.
Usage
- Using the
.query(argument)method will send theSLISt:NAME? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:NAME? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SLISt:NAME? <Index>
Info
<Index>::=.
SlistSize
¶
Bases: SCPICmdRead
The SLISt:SIZE command.
Description
- This command returns the number sequences in sequence list.
Usage
- Using the
.query()method will send theSLISt:SIZE?query. - Using the
.verify(value)method will send theSLISt:SIZE?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SLISt:SIZE?
SlistSubsequence
¶
Bases: SCPICmdRead
The SLISt:SUBSequence command tree.
Usage
- Using the
.query()method will send theSLISt:SUBSequence?query. - Using the
.verify(value)method will send theSLISt:SUBSequence?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.delete: TheSLISt:SUBSequence:DELetecommand..element: TheSLISt:SUBSequence:ELEMent[n]command tree..length: TheSLISt:SUBSequence:LENGthcommand..new: TheSLISt:SUBSequence:NEWcommand..tstamp: TheSLISt:SUBSequence:TSTampcommand.
delete
property
¶
delete: SlistSubsequenceDelete
Return the SLISt:SUBSequence:DELete command.
Description
- This command deletes the subsequence from the currently loaded setup.
Usage
- Using the
.write(value)method will send theSLISt:SUBSequence:DELete valuecommand.
SCPI Syntax
- SLISt:SUBSequence:DELete {<subseq_name>|ALL}
Info
<subseq_name>::=.
element
property
¶
element: dict[int, SlistSubsequenceElementItem]
Return the SLISt:SUBSequence:ELEMent[n] command tree.
Usage
- Using the
.query()method will send theSLISt:SUBSequence:ELEMent[n]?query. - Using the
.verify(value)method will send theSLISt:SUBSequence:ELEMent[n]?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.loop: TheSLISt:SUBSequence:ELEMent[n]:LOOPcommand tree..waveform: TheSLISt:SUBSequence:ELEMent[n]:WAVeform[n]command.
length
property
¶
length: SlistSubsequenceLength
Return the SLISt:SUBSequence:LENGth command.
Description
- This command and query sets or returns the size of the subsequence.
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:LENGth? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:LENGth? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theSLISt:SUBSequence:LENGth valuecommand.
SCPI Syntax
- SLISt:SUBSequence:LENGth <subseq_name>,<NR1>
- SLISt:SUBSequence:LENGth? <subseq_name>
Info
<subseq_name>::=.
new
property
¶
new: SlistSubsequenceNew
Return the SLISt:SUBSequence:NEW command.
Description
- This command creates a new subsequence.
Usage
- Using the
.write(value)method will send theSLISt:SUBSequence:NEW valuecommand.
SCPI Syntax
- SLISt:SUBSequence:NEW <subseq_name>,<length>
Info
<subseq_name>::=.
tstamp
property
¶
tstamp: SlistSubsequenceTstamp
Return the SLISt:SUBSequence:TSTamp command.
Description
- This query returns the time stamp of the subsequence. Time stamp is updated whenever
the subsequence is created or changed. It is not updated when it is renamed. It
returns date as a string in the form ‘yyyy/mm/dd
hh:mm:ss’ (a white space between data and time).
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:TSTamp? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:TSTamp? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SLISt:SUBSequence:TSTamp? <subseq_name>
Info
<subseq_name>::=.
SlistSubsequenceDelete
¶
Bases: SCPICmdWrite
The SLISt:SUBSequence:DELete command.
Description
- This command deletes the subsequence from the currently loaded setup.
Usage
- Using the
.write(value)method will send theSLISt:SUBSequence:DELete valuecommand.
SCPI Syntax
- SLISt:SUBSequence:DELete {<subseq_name>|ALL}
Info
<subseq_name>::=.
SlistSubsequenceElementItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdRead
The SLISt:SUBSequence:ELEMent[n] command tree.
Usage
- Using the
.query()method will send theSLISt:SUBSequence:ELEMent[n]?query. - Using the
.verify(value)method will send theSLISt:SUBSequence:ELEMent[n]?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.loop: TheSLISt:SUBSequence:ELEMent[n]:LOOPcommand tree..waveform: TheSLISt:SUBSequence:ELEMent[n]:WAVeform[n]command.
loop
property
¶
Return the SLISt:SUBSequence:ELEMent[n]:LOOP command tree.
Usage
- Using the
.query()method will send theSLISt:SUBSequence:ELEMent[n]:LOOP?query. - Using the
.verify(value)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.count: TheSLISt:SUBSequence:ELEMent[n]:LOOP:COUNtcommand.
waveform
property
¶
waveform: dict[int, SlistSubsequenceElementItemWaveformItem]
Return the SLISt:SUBSequence:ELEMent[n]:WAVeform[n] command.
Description
- This command and query sets or returns the waveform for an element of the subsequence. The value of n = 1 | 2 | 3 | 4 based on the model. If suffix is not specified, the value of n is 1. The value of ‘n’ indicates which channel will output the waveform when the sequence is run.
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:ELEMent[n]:WAVeform[n]? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:ELEMent[n]:WAVeform[n]? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theSLISt:SUBSequence:ELEMent[n]:WAVeform[n] valuecommand.
SCPI Syntax
- SLISt:SUBSequence:ELEMent[n]:WAVeform[n] <subseq_name>,<wfm_name>
- SLISt:SUBSequence:ELEMent[n]:WAVeform[n]? <subseq_name>
Info
<subseq_name>::=. <wfm_name>::=.
SlistSubsequenceElementItemLoop
¶
Bases: SCPICmdRead
The SLISt:SUBSequence:ELEMent[n]:LOOP command tree.
Usage
- Using the
.query()method will send theSLISt:SUBSequence:ELEMent[n]:LOOP?query. - Using the
.verify(value)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.count: TheSLISt:SUBSequence:ELEMent[n]:LOOP:COUNtcommand.
count
property
¶
Return the SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt command.
Description
- This command and query sets or returns the loop count for the specified subsequence element. The loop count is an integer.
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP:COUNt valuecommand.
SCPI Syntax
- SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt <subseq_name>,<NR1>
- SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? <subseq_name>
SlistSubsequenceElementItemLoopCount
¶
Bases: SCPICmdWrite, SCPICmdReadWithArguments
The SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt command.
Description
- This command and query sets or returns the loop count for the specified subsequence element. The loop count is an integer.
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theSLISt:SUBSequence:ELEMent[n]:LOOP:COUNt valuecommand.
SCPI Syntax
- SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt <subseq_name>,<NR1>
- SLISt:SUBSequence:ELEMent[n]:LOOP:COUNt? <subseq_name>
SlistSubsequenceElementItemWaveformItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdReadWithArguments
The SLISt:SUBSequence:ELEMent[n]:WAVeform[n] command.
Description
- This command and query sets or returns the waveform for an element of the subsequence. The value of n = 1 | 2 | 3 | 4 based on the model. If suffix is not specified, the value of n is 1. The value of ‘n’ indicates which channel will output the waveform when the sequence is run.
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:ELEMent[n]:WAVeform[n]? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:ELEMent[n]:WAVeform[n]? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theSLISt:SUBSequence:ELEMent[n]:WAVeform[n] valuecommand.
SCPI Syntax
- SLISt:SUBSequence:ELEMent[n]:WAVeform[n] <subseq_name>,<wfm_name>
- SLISt:SUBSequence:ELEMent[n]:WAVeform[n]? <subseq_name>
Info
<subseq_name>::=. <wfm_name>::=.
SlistSubsequenceLength
¶
Bases: SCPICmdWrite, SCPICmdReadWithArguments
The SLISt:SUBSequence:LENGth command.
Description
- This command and query sets or returns the size of the subsequence.
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:LENGth? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:LENGth? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theSLISt:SUBSequence:LENGth valuecommand.
SCPI Syntax
- SLISt:SUBSequence:LENGth <subseq_name>,<NR1>
- SLISt:SUBSequence:LENGth? <subseq_name>
Info
<subseq_name>::=.
SlistSubsequenceNew
¶
Bases: SCPICmdWrite
The SLISt:SUBSequence:NEW command.
Description
- This command creates a new subsequence.
Usage
- Using the
.write(value)method will send theSLISt:SUBSequence:NEW valuecommand.
SCPI Syntax
- SLISt:SUBSequence:NEW <subseq_name>,<length>
Info
<subseq_name>::=.
SlistSubsequenceTstamp
¶
Bases: SCPICmdReadWithArguments
The SLISt:SUBSequence:TSTamp command.
Description
- This query returns the time stamp of the subsequence. Time stamp is updated whenever the
subsequence is created or changed. It is not updated when it is renamed. It returns date
as a string in the form ‘yyyy/mm/dd
hh:mm:ss’ (a white space between data and time).
Usage
- Using the
.query(argument)method will send theSLISt:SUBSequence:TSTamp? argumentquery. - Using the
.verify(argument, value)method will send theSLISt:SUBSequence:TSTamp? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- SLISt:SUBSequence:TSTamp? <subseq_name>
Info
<subseq_name>::=.