[python source code]

plot

The plot commands module.

These commands are used in the following models: MSO2

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries 
- PLOT:ADDNew <QString>
- PLOT:DELete <QString>
- PLOT:LIST?
- PLOT:PLOT<x>:SOUrce1 MEAS<x>
- PLOT:PLOT<x>:SOUrce1?
- PLOT:PLOT<x>:TYPe {NONE|XY}

Plot

Bases: SCPICmdRead

The PLOT command tree.

Usage
  • Using the .query() method will send the PLOT? query.
  • Using the .verify(value) method will send the PLOT? query and raise an AssertionError if the returned value does not match value.
Properties
  • .addnew: The PLOT:ADDNew command.
  • .delete: The PLOT:DELete command.
  • .list: The PLOT:LIST command.
  • .plot: The PLOT:PLOT<x> command tree.

addnew property 

addnew: PlotAddnew

Return the PLOT:ADDNew command.

Description
  • This command adds the specified plot.
Usage
  • Using the .write(value) method will send the PLOT:ADDNew value command.
SCPI Syntax 
- PLOT:ADDNew <QString>
Info
  • <QString> is the specified plot. The argument is of the form ‘PLOT‘, where ≥ 1.

delete property 

delete: PlotDelete

Return the PLOT:DELete command.

Description
  • This command deletes the specified plot.
Usage
  • Using the .write(value) method will send the PLOT:DELete value command.
SCPI Syntax 
- PLOT:DELete <QString>
Info
  • <QString> is the specified plot. Argument is of the form ‘PLOT, where is ≥ 1).

list property 

list: PlotList

Return the PLOT:LIST command.

Description
  • This command lists all currently defined plots.
Usage
  • Using the .query() method will send the PLOT:LIST? query.
  • Using the .verify(value) method will send the PLOT:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- PLOT:LIST?

plot property 

plot: dict[int, PlotPlotItem]

Return the PLOT:PLOT<x> command tree.

Usage
  • Using the .query() method will send the PLOT:PLOT<x>? query.
  • Using the .verify(value) method will send the PLOT:PLOT<x>? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .source1: The PLOT:PLOT<x>:SOUrce1 command.
  • .type: The PLOT:PLOT<x>:TYPe command.

PlotAddnew

Bases: SCPICmdWrite

The PLOT:ADDNew command.

Description
  • This command adds the specified plot.
Usage
  • Using the .write(value) method will send the PLOT:ADDNew value command.
SCPI Syntax 
- PLOT:ADDNew <QString>
Info
  • <QString> is the specified plot. The argument is of the form ‘PLOT‘, where ≥ 1.

PlotDelete

Bases: SCPICmdWrite

The PLOT:DELete command.

Description
  • This command deletes the specified plot.
Usage
  • Using the .write(value) method will send the PLOT:DELete value command.
SCPI Syntax 
- PLOT:DELete <QString>
Info
  • <QString> is the specified plot. Argument is of the form ‘PLOT, where is ≥ 1).

PlotList

Bases: SCPICmdRead

The PLOT:LIST command.

Description
  • This command lists all currently defined plots.
Usage
  • Using the .query() method will send the PLOT:LIST? query.
  • Using the .verify(value) method will send the PLOT:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- PLOT:LIST?

PlotPlotItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The PLOT:PLOT<x> command tree.

Usage
  • Using the .query() method will send the PLOT:PLOT<x>? query.
  • Using the .verify(value) method will send the PLOT:PLOT<x>? query and raise an AssertionError if the returned value does not match value.
Properties
  • .source1: The PLOT:PLOT<x>:SOUrce1 command.
  • .type: The PLOT:PLOT<x>:TYPe command.

source1 property 

source1: PlotPlotItemSource1

Return the PLOT:PLOT<x>:SOUrce1 command.

Description
  • This command sets or queries the plot source.
Usage
  • Using the .query() method will send the PLOT:PLOT<x>:SOUrce1? query.
  • Using the .verify(value) method will send the PLOT:PLOT<x>:SOUrce1? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the PLOT:PLOT<x>:SOUrce1 value command.
SCPI Syntax 
- PLOT:PLOT<x>:SOUrce1 MEAS<x>
- PLOT:PLOT<x>:SOUrce1?
Info
  • MEAS<x> is the specified measurement source for the specified plot.

type property 

type: PlotPlotItemType

Return the PLOT:PLOT<x>:TYPe command.

Description
  • This command sets or returns the current plot type of the specified plot.
Usage
  • Using the .write(value) method will send the PLOT:PLOT<x>:TYPe value command.
SCPI Syntax 
- PLOT:PLOT<x>:TYPe {NONE|XY}
Info
  • <x> is the plot number. This is the equivalent of the number shown on a plot heading in the UI.
  • NONE does not create a plot.
  • XY creates a XY plot.

PlotPlotItemSource1

Bases: SCPICmdWrite, SCPICmdRead

The PLOT:PLOT<x>:SOUrce1 command.

Description
  • This command sets or queries the plot source.
Usage
  • Using the .query() method will send the PLOT:PLOT<x>:SOUrce1? query.
  • Using the .verify(value) method will send the PLOT:PLOT<x>:SOUrce1? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the PLOT:PLOT<x>:SOUrce1 value command.
SCPI Syntax 
- PLOT:PLOT<x>:SOUrce1 MEAS<x>
- PLOT:PLOT<x>:SOUrce1?
Info
  • MEAS<x> is the specified measurement source for the specified plot.

PlotPlotItemType

Bases: SCPICmdWrite

The PLOT:PLOT<x>:TYPe command.

Description
  • This command sets or returns the current plot type of the specified plot.
Usage
  • Using the .write(value) method will send the PLOT:PLOT<x>:TYPe value command.
SCPI Syntax 
- PLOT:PLOT<x>:TYPe {NONE|XY}
Info
  • <x> is the plot number. This is the equivalent of the number shown on a plot heading in the UI.
  • NONE does not create a plot.
  • XY creates a XY plot.