[python source code]

ref

The ref 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 
- REF:ADDNew <QString>
- REF:DELete <QString>
- REF:LIST?
- REF:REF<x>:DESKew <NR3>
- REF:REF<x>:DESKew?
- REF:REF<x>:LABel:COLor <QString>
- REF:REF<x>:LABel:COLor?
- REF:REF<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:BOLD?
- REF:REF<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:ITALic?
- REF:REF<x>:LABel:FONT:SIZE <NR1>
- REF:REF<x>:LABel:FONT:SIZE?
- REF:REF<x>:LABel:FONT:TYPE <QString>
- REF:REF<x>:LABel:FONT:TYPE?
- REF:REF<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:UNDERline?
- REF:REF<x>:LABel:NAMe <QString>
- REF:REF<x>:LABel:NAMe?
- REF:REF<x>:LABel:XPOS <NR1>
- REF:REF<x>:LABel:XPOS?
- REF:REF<x>:LABel:YPOS <NR1>
- REF:REF<x>:LABel:YPOS?
- REF:REF<x>:SOUrce <QString>
- REF:REF<x>:SOUrce?

Ref

Bases: SCPICmdRead

The REF command tree.

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

addnew property 

addnew: RefAddnew

Return the REF:ADDNew command.

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

delete property 

delete: RefDelete

Return the REF:DELete command.

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

list property 

list: RefList

Return the REF:LIST command.

Description
  • This command returns a comma separated list of all currently defined references.
Usage
  • Using the .query() method will send the REF:LIST? query.
  • Using the .verify(value) method will send the REF:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- REF:LIST?

ref property 

ref: dict[int, RefRefItem]

Return the REF:REF<x> command tree.

Usage
  • Using the .query() method will send the REF:REF<x>? query.
  • Using the .verify(value) method will send the REF:REF<x>? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .deskew: The REF:REF<x>:DESKew command.
  • .label: The REF:REF<x>:LABel command tree.
  • .source: The REF:REF<x>:SOUrce command.

RefAddnew

Bases: SCPICmdWrite

The REF:ADDNew command.

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

RefDelete

Bases: SCPICmdWrite

The REF:DELete command.

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

RefList

Bases: SCPICmdRead

The REF:LIST command.

Description
  • This command returns a comma separated list of all currently defined references.
Usage
  • Using the .query() method will send the REF:LIST? query.
  • Using the .verify(value) method will send the REF:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- REF:LIST?

RefRefItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The REF:REF<x> command tree.

Usage
  • Using the .query() method will send the REF:REF<x>? query.
  • Using the .verify(value) method will send the REF:REF<x>? query and raise an AssertionError if the returned value does not match value.
Properties
  • .deskew: The REF:REF<x>:DESKew command.
  • .label: The REF:REF<x>:LABel command tree.
  • .source: The REF:REF<x>:SOUrce command.

deskew property 

deskew: RefRefItemDeskew

Return the REF:REF<x>:DESKew command.

Description
  • This command sets or queries the deskew value used for the specified reference.
Usage
  • Using the .query() method will send the REF:REF<x>:DESKew? query.
  • Using the .verify(value) method will send the REF:REF<x>:DESKew? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:DESKew value command.
SCPI Syntax 
- REF:REF<x>:DESKew <NR3>
- REF:REF<x>:DESKew?
Info
  • <NR3> is the deskew value used for the specified reference.

label property 

label: RefRefItemLabel

Return the REF:REF<x>:LABel command tree.

Usage
  • Using the .query() method will send the REF:REF<x>:LABel? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .color: The REF:REF<x>:LABel:COLor command.
  • .font: The REF:REF<x>:LABel:FONT command tree.
  • .name: The REF:REF<x>:LABel:NAMe command.
  • .xpos: The REF:REF<x>:LABel:XPOS command.
  • .ypos: The REF:REF<x>:LABel:YPOS command.

source property 

source: RefRefItemSource

Return the REF:REF<x>:SOUrce command.

Description
  • This command sets or queries the filename used by the given reference.
Usage
  • Using the .query() method will send the REF:REF<x>:SOUrce? query.
  • Using the .verify(value) method will send the REF:REF<x>:SOUrce? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:SOUrce value command.
SCPI Syntax 
- REF:REF<x>:SOUrce <QString>
- REF:REF<x>:SOUrce?
Info
  • <QString> is the reference file name.

RefRefItemDeskew

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:DESKew command.

Description
  • This command sets or queries the deskew value used for the specified reference.
Usage
  • Using the .query() method will send the REF:REF<x>:DESKew? query.
  • Using the .verify(value) method will send the REF:REF<x>:DESKew? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:DESKew value command.
SCPI Syntax 
- REF:REF<x>:DESKew <NR3>
- REF:REF<x>:DESKew?
Info
  • <NR3> is the deskew value used for the specified reference.

RefRefItemLabel

Bases: SCPICmdRead

The REF:REF<x>:LABel command tree.

Usage
  • Using the .query() method will send the REF:REF<x>:LABel? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel? query and raise an AssertionError if the returned value does not match value.
Properties
  • .color: The REF:REF<x>:LABel:COLor command.
  • .font: The REF:REF<x>:LABel:FONT command tree.
  • .name: The REF:REF<x>:LABel:NAMe command.
  • .xpos: The REF:REF<x>:LABel:XPOS command.
  • .ypos: The REF:REF<x>:LABel:YPOS command.

color property 

color: RefRefItemLabelColor

Return the REF:REF<x>:LABel:COLor command.

Description
  • This command sets or queries the color of the specified ref label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:COLor? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:COLor? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:COLor value command.
SCPI Syntax 
- REF:REF<x>:LABel:COLor <QString>
- REF:REF<x>:LABel:COLor?
Info
  • <QString> is the label. To return the color to the default color, send an empty string as in this example: :REF:REF1:LABEL:COLOR ‘’.

font property 

font: RefRefItemLabelFont

Return the REF:REF<x>:LABel:FONT command tree.

Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .bold: The REF:REF<x>:LABel:FONT:BOLD command.
  • .italic: The REF:REF<x>:LABel:FONT:ITALic command.
  • .size: The REF:REF<x>:LABel:FONT:SIZE command.
  • .type: The REF:REF<x>:LABel:FONT:TYPE command.
  • .underline: The REF:REF<x>:LABel:FONT:UNDERline command.

name property 

name: RefRefItemLabelName

Return the REF:REF<x>:LABel:NAMe command.

Description
  • This command sets or queries the label of the specified reference. The reference waveform is specified by x.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:NAMe? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:NAMe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:NAMe value command.
SCPI Syntax 
- REF:REF<x>:LABel:NAMe <QString>
- REF:REF<x>:LABel:NAMe?
Info
  • <QString> is the character string that will be used for the reference waveform label name.

xpos property 

xpos: RefRefItemLabelXpos

Return the REF:REF<x>:LABel:XPOS command.

Description
  • This command sets or queries the X-position at which the label (attached to the displayed waveform of the specified reference) is displayed, relative to the left edge of the waveview. The reference waveform is specified by x.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:XPOS? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:XPOS? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:XPOS value command.
SCPI Syntax 
- REF:REF<x>:LABel:XPOS <NR1>
- REF:REF<x>:LABel:XPOS?
Info
  • <NR1> is the location (control in divisions) where the waveform label for the selected reference is displayed, relative to the left edge of the screen.

ypos property 

ypos: RefRefItemLabelYpos

Return the REF:REF<x>:LABel:YPOS command.

Description
  • This command sets or queries the Y-position of the label (attached to the displayed waveform of the specified reference), relative to the baseline of the waveform. The reference waveform is specified by x.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:YPOS? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:YPOS? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:YPOS value command.
SCPI Syntax 
- REF:REF<x>:LABel:YPOS <NR1>
- REF:REF<x>:LABel:YPOS?
Info
  • <NR1> is the location where the waveform label for the selected reference is displayed, relative to the baseline of the waveform.

RefRefItemLabelColor

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:COLor command.

Description
  • This command sets or queries the color of the specified ref label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:COLor? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:COLor? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:COLor value command.
SCPI Syntax 
- REF:REF<x>:LABel:COLor <QString>
- REF:REF<x>:LABel:COLor?
Info
  • <QString> is the label. To return the color to the default color, send an empty string as in this example: :REF:REF1:LABEL:COLOR ‘’.

RefRefItemLabelFont

Bases: SCPICmdRead

The REF:REF<x>:LABel:FONT command tree.

Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT? query and raise an AssertionError if the returned value does not match value.
Properties
  • .bold: The REF:REF<x>:LABel:FONT:BOLD command.
  • .italic: The REF:REF<x>:LABel:FONT:ITALic command.
  • .size: The REF:REF<x>:LABel:FONT:SIZE command.
  • .type: The REF:REF<x>:LABel:FONT:TYPE command.
  • .underline: The REF:REF<x>:LABel:FONT:UNDERline command.

bold property 

bold: RefRefItemLabelFontBold

Return the REF:REF<x>:LABel:FONT:BOLD command.

Description
  • This command sets or queries the bold state of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:BOLD? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:BOLD? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:BOLD value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:BOLD?
Info
  • <NR1> = 0 disables bold font; any other value turns this feature on.
  • OFF disables bold font.
  • ON enables bold font.

italic property 

italic: RefRefItemLabelFontItalic

Return the REF:REF<x>:LABel:FONT:ITALic command.

Description
  • This command sets or queries the italic state of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:ITALic? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:ITALic? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:ITALic value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:ITALic?
Info
  • <NR1> = 0 disables italic font; any other value turns this feature on.
  • OFF disables italic font.
  • ON enables italic font.

size property 

size: RefRefItemLabelFontSize

Return the REF:REF<x>:LABel:FONT:SIZE command.

Description
  • This command sets or queries the font size of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:SIZE? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:SIZE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:SIZE value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:SIZE <NR1>
- REF:REF<x>:LABel:FONT:SIZE?
Info
  • <NR1> is the font size of the label.

type property 

type: RefRefItemLabelFontType

Return the REF:REF<x>:LABel:FONT:TYPE command.

Description
  • This command sets or queries the font type of the specified reference label, such as Arial or Times New Roman.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:TYPE? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:TYPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:TYPE value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:TYPE <QString>
- REF:REF<x>:LABel:FONT:TYPE?
Info
  • <QString> is the font type.

underline property 

underline: RefRefItemLabelFontUnderline

Return the REF:REF<x>:LABel:FONT:UNDERline command.

Description
  • This command sets or queries the underline state of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:UNDERline? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:UNDERline? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:UNDERline value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:UNDERline?
Info
  • <NR1> = 0 disables underline font; any other value turns this feature on.
  • OFF disables underline font.
  • ON enables underline font.

RefRefItemLabelFontBold

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:FONT:BOLD command.

Description
  • This command sets or queries the bold state of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:BOLD? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:BOLD? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:BOLD value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:BOLD?
Info
  • <NR1> = 0 disables bold font; any other value turns this feature on.
  • OFF disables bold font.
  • ON enables bold font.

RefRefItemLabelFontItalic

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:FONT:ITALic command.

Description
  • This command sets or queries the italic state of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:ITALic? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:ITALic? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:ITALic value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:ITALic?
Info
  • <NR1> = 0 disables italic font; any other value turns this feature on.
  • OFF disables italic font.
  • ON enables italic font.

RefRefItemLabelFontSize

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:FONT:SIZE command.

Description
  • This command sets or queries the font size of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:SIZE? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:SIZE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:SIZE value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:SIZE <NR1>
- REF:REF<x>:LABel:FONT:SIZE?
Info
  • <NR1> is the font size of the label.

RefRefItemLabelFontType

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:FONT:TYPE command.

Description
  • This command sets or queries the font type of the specified reference label, such as Arial or Times New Roman.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:TYPE? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:TYPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:TYPE value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:TYPE <QString>
- REF:REF<x>:LABel:FONT:TYPE?
Info
  • <QString> is the font type.

RefRefItemLabelFontUnderline

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:FONT:UNDERline command.

Description
  • This command sets or queries the underline state of the specified reference label.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:FONT:UNDERline? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:FONT:UNDERline? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:FONT:UNDERline value command.
SCPI Syntax 
- REF:REF<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- REF:REF<x>:LABel:FONT:UNDERline?
Info
  • <NR1> = 0 disables underline font; any other value turns this feature on.
  • OFF disables underline font.
  • ON enables underline font.

RefRefItemLabelName

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:NAMe command.

Description
  • This command sets or queries the label of the specified reference. The reference waveform is specified by x.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:NAMe? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:NAMe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:NAMe value command.
SCPI Syntax 
- REF:REF<x>:LABel:NAMe <QString>
- REF:REF<x>:LABel:NAMe?
Info
  • <QString> is the character string that will be used for the reference waveform label name.

RefRefItemLabelXpos

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:XPOS command.

Description
  • This command sets or queries the X-position at which the label (attached to the displayed waveform of the specified reference) is displayed, relative to the left edge of the waveview. The reference waveform is specified by x.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:XPOS? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:XPOS? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:XPOS value command.
SCPI Syntax 
- REF:REF<x>:LABel:XPOS <NR1>
- REF:REF<x>:LABel:XPOS?
Info
  • <NR1> is the location (control in divisions) where the waveform label for the selected reference is displayed, relative to the left edge of the screen.

RefRefItemLabelYpos

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:LABel:YPOS command.

Description
  • This command sets or queries the Y-position of the label (attached to the displayed waveform of the specified reference), relative to the baseline of the waveform. The reference waveform is specified by x.
Usage
  • Using the .query() method will send the REF:REF<x>:LABel:YPOS? query.
  • Using the .verify(value) method will send the REF:REF<x>:LABel:YPOS? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:LABel:YPOS value command.
SCPI Syntax 
- REF:REF<x>:LABel:YPOS <NR1>
- REF:REF<x>:LABel:YPOS?
Info
  • <NR1> is the location where the waveform label for the selected reference is displayed, relative to the baseline of the waveform.

RefRefItemSource

Bases: SCPICmdWrite, SCPICmdRead

The REF:REF<x>:SOUrce command.

Description
  • This command sets or queries the filename used by the given reference.
Usage
  • Using the .query() method will send the REF:REF<x>:SOUrce? query.
  • Using the .verify(value) method will send the REF:REF<x>:SOUrce? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the REF:REF<x>:SOUrce value command.
SCPI Syntax 
- REF:REF<x>:SOUrce <QString>
- REF:REF<x>:SOUrce?
Info
  • <QString> is the reference file name.