[python source code]

mark

The mark commands module.

These commands are used in the following models: DPO5K, DPO5KB, DPO70KC, DPO70KD, DPO70KDX, DPO70KSX, DPO7K, DPO7KC, DSA70KC, DSA70KD, MSO5K, MSO5KB, MSO70KC, MSO70KDX

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

Please report an issue if one is found.

Commands and Queries 
- MARK {NEXT|PREVious}
- MARK:CREATE {CH<x>|MATH<x>|REF<x>|COLUMN}
- MARK:DELEte {CH<x>|MATH<x>|SELECTED|REF<x>|ALL|COLUMN}
- MARK:FREE?
- MARK:SELECTED:END?
- MARK:SELECTED:FOCUS?
- MARK:SELECTED:LABel <QString>
- MARK:SELECTED:LABel?
- MARK:SELECTED:MARKSINCOLumn?
- MARK:SELECTED:OWNer?
- MARK:SELECTED:SOUrce?
- MARK:SELECTED:STARt?
- MARK:SELECTED:STATE {ON|OFF|<NR1>}
- MARK:SELECTED:STATE?
- MARK:SELECTED:ZOOm:POSition?
- MARK:SELECTED:ZOOm:SCAle?
- MARK:TOTal?
- MARK?

Mark

Bases: SCPICmdWrite, SCPICmdRead

The MARK command.

Description
  • Moves to the next or previous reference mark on the waveform. Returns the current mark position.
Usage
  • Using the .query() method will send the MARK? query.
  • Using the .verify(value) method will send the MARK? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MARK value command.
SCPI Syntax 
- MARK {NEXT|PREVious}
- MARK?
Info
  • NEXT moves to the next reference mark on the right.
  • PREVious moves to the next reference mark on the left.
Properties
  • .create: The MARK:CREATE command.
  • .delete: The MARK:DELEte command.
  • .free: The MARK:FREE command.
  • .selected: The MARK:SELECTED command tree.
  • .total: The MARK:TOTal command.

create property 

create: MarkCreate

Return the MARK:CREATE command.

Description
  • This command creates a mark on a specified waveform or all waveforms in a column.
Usage
  • Using the .write(value) method will send the MARK:CREATE value command.
SCPI Syntax 
- MARK:CREATE {CH<x>|MATH<x>|REF<x>|COLUMN}
Info
  • CH<x> creates the mark on a channel waveform, where is the channel number and can be 1, 2, 3, or 4.
  • MATH<x> creates the mark on the math waveform, where is the channel number and can be 1, 2, 3, or 4.
  • REF<x> creates the mark on a reference waveform, where is the reference waveform number can be 1, 2, 3, or 4.
  • COLUMN creates marks on all waveforms in the current zoom pixel column.

delete property 

delete: MarkDelete

Return the MARK:DELEte command.

Description
  • This command deletes a mark on a particular waveform, all waveforms in a column, the selected mark, or all marks.
Usage
  • Using the .write(value) method will send the MARK:DELEte value command.
SCPI Syntax 
- MARK:DELEte {CH<x>|MATH<x>|SELECTED|REF<x>|ALL|COLUMN}
Info
  • CH<x> deletes the mark on a channel waveform, where is the channel number and can be 1, 2, 3, or 4.
  • MATH<x> deletes the mark on the math waveform, where is the channel number and can be 1, 2, 3, or 4.
  • SELECTED deletes the mark on the selected waveform.
  • REF<x> deletes the mark on a reference waveform, where is the reference waveform number and can be 1, 2, 3, or 4.
  • ALL deletes all marks on all waveforms.
  • COLUMN deletes marks on all waveforms in the current zoom pixel column.

free property 

free: MarkFree

Return the MARK:FREE command.

Description
  • Returns how many marks are available for use. There can be a total of 1,024 marks returned.
Usage
  • Using the .query() method will send the MARK:FREE? query.
  • Using the .verify(value) method will send the MARK:FREE? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:FREE?

selected property 

selected: MarkSelected

Return the MARK:SELECTED command tree.

Usage
  • Using the .query() method will send the MARK:SELECTED? query.
  • Using the .verify(value) method will send the MARK:SELECTED? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .end: The MARK:SELECTED:END command.
  • .focus: The MARK:SELECTED:FOCUS command.
  • .label: The MARK:SELECTED:LABel command.
  • .marksincolumn: The MARK:SELECTED:MARKSINCOLumn command.
  • .owner: The MARK:SELECTED:OWNer command.
  • .source: The MARK:SELECTED:SOUrce command.
  • .start: The MARK:SELECTED:STARt command.
  • .state: The MARK:SELECTED:STATE command.
  • .zoom: The MARK:SELECTED:ZOOm command tree.

total property 

total: MarkTotal

Return the MARK:TOTal command.

Description
  • Returns how many marks are currently in use. There can be a total of 1,024 marks returned.
Usage
  • Using the .query() method will send the MARK:TOTal? query.
  • Using the .verify(value) method will send the MARK:TOTal? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:TOTal?

MarkCreate

Bases: SCPICmdWrite

The MARK:CREATE command.

Description
  • This command creates a mark on a specified waveform or all waveforms in a column.
Usage
  • Using the .write(value) method will send the MARK:CREATE value command.
SCPI Syntax 
- MARK:CREATE {CH<x>|MATH<x>|REF<x>|COLUMN}
Info
  • CH<x> creates the mark on a channel waveform, where is the channel number and can be 1, 2, 3, or 4.
  • MATH<x> creates the mark on the math waveform, where is the channel number and can be 1, 2, 3, or 4.
  • REF<x> creates the mark on a reference waveform, where is the reference waveform number can be 1, 2, 3, or 4.
  • COLUMN creates marks on all waveforms in the current zoom pixel column.

MarkDelete

Bases: SCPICmdWrite

The MARK:DELEte command.

Description
  • This command deletes a mark on a particular waveform, all waveforms in a column, the selected mark, or all marks.
Usage
  • Using the .write(value) method will send the MARK:DELEte value command.
SCPI Syntax 
- MARK:DELEte {CH<x>|MATH<x>|SELECTED|REF<x>|ALL|COLUMN}
Info
  • CH<x> deletes the mark on a channel waveform, where is the channel number and can be 1, 2, 3, or 4.
  • MATH<x> deletes the mark on the math waveform, where is the channel number and can be 1, 2, 3, or 4.
  • SELECTED deletes the mark on the selected waveform.
  • REF<x> deletes the mark on a reference waveform, where is the reference waveform number and can be 1, 2, 3, or 4.
  • ALL deletes all marks on all waveforms.
  • COLUMN deletes marks on all waveforms in the current zoom pixel column.

MarkFree

Bases: SCPICmdRead

The MARK:FREE command.

Description
  • Returns how many marks are available for use. There can be a total of 1,024 marks returned.
Usage
  • Using the .query() method will send the MARK:FREE? query.
  • Using the .verify(value) method will send the MARK:FREE? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:FREE?

MarkSelected

Bases: SCPICmdRead

The MARK:SELECTED command tree.

Usage
  • Using the .query() method will send the MARK:SELECTED? query.
  • Using the .verify(value) method will send the MARK:SELECTED? query and raise an AssertionError if the returned value does not match value.
Properties
  • .end: The MARK:SELECTED:END command.
  • .focus: The MARK:SELECTED:FOCUS command.
  • .label: The MARK:SELECTED:LABel command.
  • .marksincolumn: The MARK:SELECTED:MARKSINCOLumn command.
  • .owner: The MARK:SELECTED:OWNer command.
  • .source: The MARK:SELECTED:SOUrce command.
  • .start: The MARK:SELECTED:STARt command.
  • .state: The MARK:SELECTED:STATE command.
  • .zoom: The MARK:SELECTED:ZOOm command tree.

end property 

end: MarkSelectedEnd

Return the MARK:SELECTED:END command.

Description
  • This query-only command returns the end of the selected mark, 0 to 100% of the waveform.
Usage
  • Using the .query() method will send the MARK:SELECTED:END? query.
  • Using the .verify(value) method will send the MARK:SELECTED:END? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:END?

focus property 

focus: MarkSelectedFocus

Return the MARK:SELECTED:FOCUS command.

Description
  • This query-only command returns the focus of the selected mark, 0 to 100% of the waveform.
Usage
  • Using the .query() method will send the MARK:SELECTED:FOCUS? query.
  • Using the .verify(value) method will send the MARK:SELECTED:FOCUS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:FOCUS?

label property 

label: MarkSelectedLabel

Return the MARK:SELECTED:LABel command.

Description
  • This command sets or queries the label for the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:LABel? query.
  • Using the .verify(value) method will send the MARK:SELECTED:LABel? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MARK:SELECTED:LABel value command.
SCPI Syntax 
- MARK:SELECTED:LABel <QString>
- MARK:SELECTED:LABel?
Info
  • <QString> is the quoted string label for the mark.

marksincolumn property 

marksincolumn: MarkSelectedMarksincolumn

Return the MARK:SELECTED:MARKSINCOLumn command.

Description
  • This query-only command returns the number of marks in the current zoom pixel column.
Usage
  • Using the .query() method will send the MARK:SELECTED:MARKSINCOLumn? query.
  • Using the .verify(value) method will send the MARK:SELECTED:MARKSINCOLumn? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:MARKSINCOLumn?
Info
  • MARK:SELECTED:MARKSINCOLUMN? might return :MARK:SELECTED:MARKSINCOLUMN 1, indicating there is 1 mark in the pixel column.

owner property 

owner: MarkSelectedOwner

Return the MARK:SELECTED:OWNer command.

Description
  • This query-only command returns the owner of the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:OWNer? query.
  • Using the .verify(value) method will send the MARK:SELECTED:OWNer? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:OWNer?

source property 

source: MarkSelectedSource

Return the MARK:SELECTED:SOUrce command.

Description
  • This query-only command returns the source waveform for the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:SOUrce? query.
  • Using the .verify(value) method will send the MARK:SELECTED:SOUrce? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:SOUrce?

start property 

start: MarkSelectedStart

Return the MARK:SELECTED:STARt command.

Description
  • This query-only command returns the starting point of the selected mark, 0 to 100% of the waveform.
Usage
  • Using the .query() method will send the MARK:SELECTED:STARt? query.
  • Using the .verify(value) method will send the MARK:SELECTED:STARt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:STARt?

state property 

state: MarkSelectedState

Return the MARK:SELECTED:STATE command.

Description
  • This command sets or queries the on or off state of the selected mark. The selected mark is at or near the center of the display. If you push the Set/Clear button, this mark will disappear.
Usage
  • Using the .query() method will send the MARK:SELECTED:STATE? query.
  • Using the .verify(value) method will send the MARK:SELECTED:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MARK:SELECTED:STATE value command.
SCPI Syntax 
- MARK:SELECTED:STATE {ON|OFF|<NR1>}
- MARK:SELECTED:STATE?
Info
  • <NR1> = 0 disables the selected mark; any other value enables the selected mark. For queries, a 0 is returned if the selected mark state is off; a 1 is returned if the selected mark state is on.
  • OFF argument disables selected mark.
  • ON argument enables the selected mark.

zoom property 

zoom: MarkSelectedZoom

Return the MARK:SELECTED:ZOOm command tree.

Usage
  • Using the .query() method will send the MARK:SELECTED:ZOOm? query.
  • Using the .verify(value) method will send the MARK:SELECTED:ZOOm? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .position: The MARK:SELECTED:ZOOm:POSition command.
  • .scale: The MARK:SELECTED:ZOOm:SCAle command.

MarkSelectedEnd

Bases: SCPICmdRead

The MARK:SELECTED:END command.

Description
  • This query-only command returns the end of the selected mark, 0 to 100% of the waveform.
Usage
  • Using the .query() method will send the MARK:SELECTED:END? query.
  • Using the .verify(value) method will send the MARK:SELECTED:END? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:END?

MarkSelectedFocus

Bases: SCPICmdRead

The MARK:SELECTED:FOCUS command.

Description
  • This query-only command returns the focus of the selected mark, 0 to 100% of the waveform.
Usage
  • Using the .query() method will send the MARK:SELECTED:FOCUS? query.
  • Using the .verify(value) method will send the MARK:SELECTED:FOCUS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:FOCUS?

MarkSelectedLabel

Bases: SCPICmdWrite, SCPICmdRead

The MARK:SELECTED:LABel command.

Description
  • This command sets or queries the label for the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:LABel? query.
  • Using the .verify(value) method will send the MARK:SELECTED:LABel? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MARK:SELECTED:LABel value command.
SCPI Syntax 
- MARK:SELECTED:LABel <QString>
- MARK:SELECTED:LABel?
Info
  • <QString> is the quoted string label for the mark.

MarkSelectedMarksincolumn

Bases: SCPICmdRead

The MARK:SELECTED:MARKSINCOLumn command.

Description
  • This query-only command returns the number of marks in the current zoom pixel column.
Usage
  • Using the .query() method will send the MARK:SELECTED:MARKSINCOLumn? query.
  • Using the .verify(value) method will send the MARK:SELECTED:MARKSINCOLumn? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:MARKSINCOLumn?
Info
  • MARK:SELECTED:MARKSINCOLUMN? might return :MARK:SELECTED:MARKSINCOLUMN 1, indicating there is 1 mark in the pixel column.

MarkSelectedOwner

Bases: SCPICmdRead

The MARK:SELECTED:OWNer command.

Description
  • This query-only command returns the owner of the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:OWNer? query.
  • Using the .verify(value) method will send the MARK:SELECTED:OWNer? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:OWNer?

MarkSelectedSource

Bases: SCPICmdRead

The MARK:SELECTED:SOUrce command.

Description
  • This query-only command returns the source waveform for the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:SOUrce? query.
  • Using the .verify(value) method will send the MARK:SELECTED:SOUrce? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:SOUrce?

MarkSelectedStart

Bases: SCPICmdRead

The MARK:SELECTED:STARt command.

Description
  • This query-only command returns the starting point of the selected mark, 0 to 100% of the waveform.
Usage
  • Using the .query() method will send the MARK:SELECTED:STARt? query.
  • Using the .verify(value) method will send the MARK:SELECTED:STARt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:STARt?

MarkSelectedState

Bases: SCPICmdWrite, SCPICmdRead

The MARK:SELECTED:STATE command.

Description
  • This command sets or queries the on or off state of the selected mark. The selected mark is at or near the center of the display. If you push the Set/Clear button, this mark will disappear.
Usage
  • Using the .query() method will send the MARK:SELECTED:STATE? query.
  • Using the .verify(value) method will send the MARK:SELECTED:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MARK:SELECTED:STATE value command.
SCPI Syntax 
- MARK:SELECTED:STATE {ON|OFF|<NR1>}
- MARK:SELECTED:STATE?
Info
  • <NR1> = 0 disables the selected mark; any other value enables the selected mark. For queries, a 0 is returned if the selected mark state is off; a 1 is returned if the selected mark state is on.
  • OFF argument disables selected mark.
  • ON argument enables the selected mark.

MarkSelectedZoom

Bases: SCPICmdRead

The MARK:SELECTED:ZOOm command tree.

Usage
  • Using the .query() method will send the MARK:SELECTED:ZOOm? query.
  • Using the .verify(value) method will send the MARK:SELECTED:ZOOm? query and raise an AssertionError if the returned value does not match value.
Properties
  • .position: The MARK:SELECTED:ZOOm:POSition command.
  • .scale: The MARK:SELECTED:ZOOm:SCAle command.

position property 

position: MarkSelectedZoomPosition

Return the MARK:SELECTED:ZOOm:POSition command.

Description
  • This query-only command returns the position of the selected mark, of the zoom overview window. If the return value is less than zero then the zoom scale will not be changed when Next or Prev makes this the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:ZOOm:POSition? query.
  • Using the .verify(value) method will send the MARK:SELECTED:ZOOm:POSition? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:ZOOm:POSition?

scale property 

scale: MarkSelectedZoomScale

Return the MARK:SELECTED:ZOOm:SCAle command.

Description
  • This query-only command returns the scale of the selected mark of the zoom overview window. The returned value might be < 0 (for example from Search), which means that the zoom scale will not be changed when Next or Prev makes this the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:ZOOm:SCAle? query.
  • Using the .verify(value) method will send the MARK:SELECTED:ZOOm:SCAle? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:ZOOm:SCAle?

MarkSelectedZoomPosition

Bases: SCPICmdRead

The MARK:SELECTED:ZOOm:POSition command.

Description
  • This query-only command returns the position of the selected mark, of the zoom overview window. If the return value is less than zero then the zoom scale will not be changed when Next or Prev makes this the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:ZOOm:POSition? query.
  • Using the .verify(value) method will send the MARK:SELECTED:ZOOm:POSition? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:ZOOm:POSition?

MarkSelectedZoomScale

Bases: SCPICmdRead

The MARK:SELECTED:ZOOm:SCAle command.

Description
  • This query-only command returns the scale of the selected mark of the zoom overview window. The returned value might be < 0 (for example from Search), which means that the zoom scale will not be changed when Next or Prev makes this the selected mark.
Usage
  • Using the .query() method will send the MARK:SELECTED:ZOOm:SCAle? query.
  • Using the .verify(value) method will send the MARK:SELECTED:ZOOm:SCAle? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:SELECTED:ZOOm:SCAle?

MarkTotal

Bases: SCPICmdRead

The MARK:TOTal command.

Description
  • Returns how many marks are currently in use. There can be a total of 1,024 marks returned.
Usage
  • Using the .query() method will send the MARK:TOTal? query.
  • Using the .verify(value) method will send the MARK:TOTal? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MARK:TOTal?