data
¶
The data commands module.
These commands are used in the following models: AFG3K, AFG3KB, AFG3KC
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Commands and Queries
- DATA:CATalog?
- DATA:COPY <trace_name>,{EMEMory[1]|EMEMory2}{EMEMory[1]|EMEMory2},{USER[1]|USER<x>}
- DATA:DATA {EMEMory|EMEMory<x>},<binary_block_data>
- DATA:DATA:LINE {EMEMory|EMEMory<x>},<start_point>,<point_data1>, <end_point>,<point_data2>
- DATA:DATA:VALue {EMEMory|EMEMory<x>},<point>,<data>
- DATA:DATA:VALue? {EMEMory[1]|EMEMory2},<points>
- DATA:DATA? {EMEMory[1]|EMEMory2}
- DATA:DEFine {EMEMory|EMEMory<x>}[,{<points>|<trace_name>}]
- DATA:DELete:NAME <trace_name>
- DATA:EMEMCOPY {EMEMory[1]|EMEMory2}, {EMEMory[1]|EMEMory2}
- DATA:LOCK:STATe {USER[1]|USER<x>},{ON|OFF|<NR1>}
- DATA:LOCK:STATe? {USER[1]|USER2|USER3|USER4}
- DATA:POINts {EMEMory|EMEMory<x>}[,<points>|MINimum|MAXimum]
- DATA:POINts? {EMEMory[1]|EMEMory2}{,MIN|MAX}
Data
¶
Bases: SCPICmdRead
The DATA command tree.
Usage
- Using the
.query()method will send theDATA?query. - Using the
.verify(value)method will send theDATA?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.catalog: TheDATA:CATalogcommand..copy: TheDATA:COPYcommand..define: TheDATA:DEFinecommand..delete: TheDATA:DELetecommand tree..ememcopy: TheDATA:EMEMCOPYcommand..lock: TheDATA:LOCKcommand tree..points: TheDATA:POINtscommand..data: TheDATA:DATAcommand.
catalog
property
¶
catalog: DataCatalog
Return the DATA:CATalog command.
Description
- This query-only command returns the names of user waveform memory and edit memory.
Usage
- Using the
.query()method will send theDATA:CATalog?query. - Using the
.verify(value)method will send theDATA:CATalog?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DATA:CATalog?
copy
property
¶
copy: DataCopy
Return the DATA:COPY command.
Description
- This command copies the contents of edit memory (or user waveform memory) to a specified user waveform memory (or edit memory).
Usage
- Using the
.write(value)method will send theDATA:COPY valuecommand.
SCPI Syntax
- DATA:COPY <trace_name>,{EMEMory[1]|EMEMory2}{EMEMory[1]|EMEMory2},{USER[1]|USER<x>}
data
property
¶
data: DataData
Return the DATA:DATA command.
Description
- This command transfers the waveform data from the external controller to the edit memory in the arbitrary function generator. The query command returns the binary block data.
Usage
- Using the
.query(argument)method will send theDATA:DATA? argumentquery. - Using the
.verify(argument, value)method will send theDATA:DATA? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:DATA valuecommand.
SCPI Syntax
- DATA:DATA {EMEMory|EMEMory<x>},<binary_block_data>
- DATA:DATA? {EMEMory[1]|EMEMory2}
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.EMEMoryrefers to the query arguments column in the table in Appendix B.EMEMory1refers to the query arguments column in the table in Appendix B.EMEMory2refers to the query arguments column in the table in Appendix B.
Sub-properties
.line: TheDATA:DATA:LINEcommand..value: TheDATA:DATA:VALuecommand.
define
property
¶
define: DataDefine
Return the DATA:DEFine command.
Description
- This command resets the contents of edit memory.
Usage
- Using the
.write(value)method will send theDATA:DEFine valuecommand.
SCPI Syntax
- DATA:DEFine {EMEMory|EMEMory<x>}[,{<points>|<trace_name>}]
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<points>::=<NR1><trace_name>::={SINusoidSQUarePULSeRAMPNOISe}
delete
property
¶
delete: DataDelete
Return the DATA:DELete command tree.
Usage
- Using the
.query()method will send theDATA:DELete?query. - Using the
.verify(value)method will send theDATA:DELete?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.name: TheDATA:DELete:NAMEcommand.
ememcopy
property
¶
ememcopy: DataEmemcopy
Return the DATA:EMEMCOPY command.
Description
- This command copies the contents of edit memory1 (or edit memory2) to edit memory2 (or edit memory1). If your arbitrary/function generator is a single-channel model, this command is not supported.
Usage
- Using the
.write(value)method will send theDATA:EMEMCOPY valuecommand.
SCPI Syntax
- DATA:EMEMCOPY {EMEMory[1]|EMEMory2}, {EMEMory[1]|EMEMory2}
Info
EMEMory[1]EMEMory2
lock
property
¶
lock: DataLock
Return the DATA:LOCK command tree.
Usage
- Using the
.query()method will send theDATA:LOCK?query. - Using the
.verify(value)method will send theDATA:LOCK?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.state: TheDATA:LOCK:STATecommand.
points
property
¶
points: DataPoints
Return the DATA:POINts command.
Description
- This command sets or queries the number of data points for the waveform created in the edit memory.
Usage
- Using the
.query(argument)method will send theDATA:POINts? argumentquery. - Using the
.verify(argument, value)method will send theDATA:POINts? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:POINts valuecommand.
SCPI Syntax
- DATA:POINts {EMEMory|EMEMory<x>}[,<points>|MINimum|MAXimum]
- DATA:POINts? {EMEMory[1]|EMEMory2}{,MIN|MAX}
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<points>::=<NR1>EMEMory[1]refers to the query arguments column in the table in Appendix B.EMEMory2refers to the query arguments column in the table in Appendix B.
DataCatalog
¶
Bases: SCPICmdRead
The DATA:CATalog command.
Description
- This query-only command returns the names of user waveform memory and edit memory.
Usage
- Using the
.query()method will send theDATA:CATalog?query. - Using the
.verify(value)method will send theDATA:CATalog?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DATA:CATalog?
DataCopy
¶
Bases: SCPICmdWrite
The DATA:COPY command.
Description
- This command copies the contents of edit memory (or user waveform memory) to a specified user waveform memory (or edit memory).
Usage
- Using the
.write(value)method will send theDATA:COPY valuecommand.
SCPI Syntax
- DATA:COPY <trace_name>,{EMEMory[1]|EMEMory2}{EMEMory[1]|EMEMory2},{USER[1]|USER<x>}
DataData
¶
Bases: SCPICmdWrite, SCPICmdReadWithArguments
The DATA:DATA command.
Description
- This command transfers the waveform data from the external controller to the edit memory in the arbitrary function generator. The query command returns the binary block data.
Usage
- Using the
.query(argument)method will send theDATA:DATA? argumentquery. - Using the
.verify(argument, value)method will send theDATA:DATA? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:DATA valuecommand.
SCPI Syntax
- DATA:DATA {EMEMory|EMEMory<x>},<binary_block_data>
- DATA:DATA? {EMEMory[1]|EMEMory2}
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.EMEMoryrefers to the query arguments column in the table in Appendix B.EMEMory1refers to the query arguments column in the table in Appendix B.EMEMory2refers to the query arguments column in the table in Appendix B.
Properties
.line: TheDATA:DATA:LINEcommand..value: TheDATA:DATA:VALuecommand.
line
property
¶
line: DataDataLine
Return the DATA:DATA:LINE command.
Description
- This command writes line data to the edit memory. The data between the specified points is interpolated linearly.
Usage
- Using the
.write(value)method will send theDATA:DATA:LINE valuecommand.
SCPI Syntax
- DATA:DATA:LINE {EMEMory|EMEMory<x>},<start_point>,<point_data1>, <end_point>,<point_data2>
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<start_point>::=<NR1><point_data1>::=<NR1><end_point>::=<NR1><point_data2>::=<NR1>
value
property
¶
value: DataDataValue
Return the DATA:DATA:VALue command.
Description
- This command sets or queries the data value at the specified point in the edit memory.
Usage
- Using the
.query(argument)method will send theDATA:DATA:VALue? argumentquery. - Using the
.verify(argument, value)method will send theDATA:DATA:VALue? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:DATA:VALue valuecommand.
SCPI Syntax
- DATA:DATA:VALue {EMEMory|EMEMory<x>},<point>,<data>
- DATA:DATA:VALue? {EMEMory[1]|EMEMory2},<points>
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<point>::=<NR1><data>::=<NR1>EMEMoryrefers to the query arguments column in the table in Appendix B.EMEMory1refers to the query arguments column in the table in Appendix B.EMEMory2refers to the query arguments column in the table in Appendix B.
DataDataLine
¶
Bases: SCPICmdWrite
The DATA:DATA:LINE command.
Description
- This command writes line data to the edit memory. The data between the specified points is interpolated linearly.
Usage
- Using the
.write(value)method will send theDATA:DATA:LINE valuecommand.
SCPI Syntax
- DATA:DATA:LINE {EMEMory|EMEMory<x>},<start_point>,<point_data1>, <end_point>,<point_data2>
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<start_point>::=<NR1><point_data1>::=<NR1><end_point>::=<NR1><point_data2>::=<NR1>
DataDataValue
¶
Bases: SCPICmdWrite, SCPICmdReadWithArguments
The DATA:DATA:VALue command.
Description
- This command sets or queries the data value at the specified point in the edit memory.
Usage
- Using the
.query(argument)method will send theDATA:DATA:VALue? argumentquery. - Using the
.verify(argument, value)method will send theDATA:DATA:VALue? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:DATA:VALue valuecommand.
SCPI Syntax
- DATA:DATA:VALue {EMEMory|EMEMory<x>},<point>,<data>
- DATA:DATA:VALue? {EMEMory[1]|EMEMory2},<points>
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<point>::=<NR1><data>::=<NR1>EMEMoryrefers to the query arguments column in the table in Appendix B.EMEMory1refers to the query arguments column in the table in Appendix B.EMEMory2refers to the query arguments column in the table in Appendix B.
DataDefine
¶
Bases: SCPICmdWrite
The DATA:DEFine command.
Description
- This command resets the contents of edit memory.
Usage
- Using the
.write(value)method will send theDATA:DEFine valuecommand.
SCPI Syntax
- DATA:DEFine {EMEMory|EMEMory<x>}[,{<points>|<trace_name>}]
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<points>::=<NR1><trace_name>::={SINusoidSQUarePULSeRAMPNOISe}
DataDelete
¶
Bases: SCPICmdRead
The DATA:DELete command tree.
Usage
- Using the
.query()method will send theDATA:DELete?query. - Using the
.verify(value)method will send theDATA:DELete?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.name: TheDATA:DELete:NAMEcommand.
name
property
¶
name: DataDeleteName
Return the DATA:DELete:NAME command.
Description
- This command deletes the contents of specified user waveform memory.
Usage
- Using the
.write(value)method will send theDATA:DELete:NAME valuecommand.
SCPI Syntax
- DATA:DELete:NAME <trace_name>
Info
<trace_name>::={USER[1]USER2USER3USER4}
DataDeleteName
¶
Bases: SCPICmdWrite
The DATA:DELete:NAME command.
Description
- This command deletes the contents of specified user waveform memory.
Usage
- Using the
.write(value)method will send theDATA:DELete:NAME valuecommand.
SCPI Syntax
- DATA:DELete:NAME <trace_name>
Info
<trace_name>::={USER[1]USER2USER3USER4}
DataEmemcopy
¶
Bases: SCPICmdWrite
The DATA:EMEMCOPY command.
Description
- This command copies the contents of edit memory1 (or edit memory2) to edit memory2 (or edit memory1). If your arbitrary/function generator is a single-channel model, this command is not supported.
Usage
- Using the
.write(value)method will send theDATA:EMEMCOPY valuecommand.
SCPI Syntax
- DATA:EMEMCOPY {EMEMory[1]|EMEMory2}, {EMEMory[1]|EMEMory2}
Info
EMEMory[1]EMEMory2
DataLock
¶
Bases: SCPICmdRead
The DATA:LOCK command tree.
Usage
- Using the
.query()method will send theDATA:LOCK?query. - Using the
.verify(value)method will send theDATA:LOCK?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.state: TheDATA:LOCK:STATecommand.
state
property
¶
state: DataLockState
Return the DATA:LOCK:STATe command.
Description
- This command sets or queries whether to lock or unlock the user waveform memory.
Usage
- Using the
.query(argument)method will send theDATA:LOCK:STATe? argumentquery. - Using the
.verify(argument, value)method will send theDATA:LOCK:STATe? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:LOCK:STATe valuecommand.
SCPI Syntax
- DATA:LOCK:STATe {USER[1]|USER<x>},{ON|OFF|<NR1>}
- DATA:LOCK:STATe? {USER[1]|USER2|USER3|USER4}
Info
ONor≠0 locks the specified user waveform memory. OFFor=0 unlocks the specified user waveform memory.
DataLockState
¶
Bases: SCPICmdWrite, SCPICmdReadWithArguments
The DATA:LOCK:STATe command.
Description
- This command sets or queries whether to lock or unlock the user waveform memory.
Usage
- Using the
.query(argument)method will send theDATA:LOCK:STATe? argumentquery. - Using the
.verify(argument, value)method will send theDATA:LOCK:STATe? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:LOCK:STATe valuecommand.
SCPI Syntax
- DATA:LOCK:STATe {USER[1]|USER<x>},{ON|OFF|<NR1>}
- DATA:LOCK:STATe? {USER[1]|USER2|USER3|USER4}
Info
ONor≠0 locks the specified user waveform memory. OFFor=0 unlocks the specified user waveform memory.
DataPoints
¶
Bases: SCPICmdWrite, SCPICmdReadWithArguments
The DATA:POINts command.
Description
- This command sets or queries the number of data points for the waveform created in the edit memory.
Usage
- Using the
.query(argument)method will send theDATA:POINts? argumentquery. - Using the
.verify(argument, value)method will send theDATA:POINts? argumentquery and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDATA:POINts valuecommand.
SCPI Syntax
- DATA:POINts {EMEMory|EMEMory<x>}[,<points>|MINimum|MAXimum]
- DATA:POINts? {EMEMory[1]|EMEMory2}{,MIN|MAX}
Info
EMEMoryrefers to the command arguments column in the table in Appendix B.EMEMory1refers to the command arguments column in the table in Appendix B.EMEMory2refers to the command arguments column in the table in Appendix B.<points>::=<NR1>EMEMory[1]refers to the query arguments column in the table in Appendix B.EMEMory2refers to the query arguments column in the table in Appendix B.