Clist

SCPI Commands :

[SOURce<HW>]:BB:DM:CLISt:CATalog
[SOURce<HW>]:BB:DM:CLISt:COPY
[SOURce<HW>]:BB:DM:CLISt:DATA
[SOURce<HW>]:BB:DM:CLISt:DELete
[SOURce<HW>]:BB:DM:CLISt:FREE
[SOURce<HW>]:BB:DM:CLISt:POINts
[SOURce<HW>]:BB:DM:CLISt:SELect
[SOURce<HW>]:BB:DM:CLISt:TAG
Commands in total: 8
Subgroups: 0
Direct child commands: 8
copy(filename: str) None[source]
# [SOURce<HW>]:BB:DM:CLISt:COPY
driver.source.bb.dm.clist.copy(filename = 'abc')

Copies the selected data list (dm_iqd) / control list (dm_iqc) as a new list with name specified by <Filename>. If a list with the specified name exists, it is overwritten. If it does not yet exist, it is created. The source file has to be available in the default directory. See also ‘Handling files in the default or in a specified directory’.

Parameters:

filename – string

delete(filename: str) None[source]
# [SOURce<HW>]:BB:DM:CLISt:DELete
driver.source.bb.dm.clist.delete(filename = 'abc')

Deletes the specified list from the default directory or from the directory specified with the complete file path. See also ‘Handling files in the default or in a specified directory’. List type / Command / File extension

  • Data list / …:DLISt… / dm_iqd

  • Control list / …:CLISt… / dm_iqc

  • User standard / …:ULISt… / dm_stu

  • User filter files / …:FLISt… / vaf

  • User mapping lists / …:MLISt… / vam

Parameters:

filename – string

get_catalog() List[str][source]
# [SOURce<HW>]:BB:DM:CLISt:CATalog
value: List[str] = driver.source.bb.dm.clist.get_catalog()

Reads out the list of files present in the default directory. List type / Command / File extension

  • Data list / …:DLISt… / dm_iqd

  • Control list / …:CLISt… / dm_iqc

  • User filter files / …:FLISt… / vaf

  • User mapping lists / …:MLISt… / vam

See also ‘Handling files in the default or in a specified directory’.

Returns:

catalog: ‘filename1,filename2,…’ Returns a string of filenames separated by commas.

get_free() int[source]
# [SOURce<HW>]:BB:DM:CLISt:FREE
value: int = driver.source.bb.dm.clist.get_free()

Queries the list free memory. List type / Command / File extension

  • Data list / …:DLISt… / dm_iqd

  • Control list / …:CLISt… / dm_iqc

  • User filter files / …:FLISt… / vaf

  • User mapping lists / …:MLISt… / vam

Returns:

free: integer Range: 0 to INT_MAX

get_points() int[source]
# [SOURce<HW>]:BB:DM:CLISt:POINts
value: int = driver.source.bb.dm.clist.get_points()

Queries the number of lines (2 bytes) in the currently selected list.

Returns:

points: integer Range: 0 to INT_MAX

get_select() str[source]
# [SOURce<HW>]:BB:DM:CLISt:SELect
value: str = driver.source.bb.dm.clist.get_select()

Selects the specified list file from the default directory or in the directory specified with the complete file path. See also method RsSmw.massMemory.current_directory() . If a list with the specified name does not yet exist, it is created. The file extension can be omitted. See also ‘Handling files in the default or in a specified directory’. List type / Command / File extension

  • Data list / …:DLISt… / dm_iqd

  • Control list / …:CLISt… / dm_iqc

  • User standard / …:ULISt… / dm_stu

  • User filter files / …:FLISt… / vaf

  • User mapping lists / …:MLISt… / vam

get_tag() str[source]
# [SOURce<HW>]:BB:DM:CLISt:TAG
value: str = driver.source.bb.dm.clist.get_tag()

Queries the content of the specified tag in the selected file.

Returns:

tag: control list,tag name For a description of the available tag formats, see ‘Tags for waveforms, data and control lists’.

set_data(data: str) None[source]
# [SOURce<HW>]:BB:DM:CLISt:DATA
driver.source.bb.dm.clist.set_data(data = 'abc')

Sends the data to the currently selected control list. If the list already contains data, it is overwritten. This command only writes data into the data section of the file. The values for the control signals are sent, arranged in an 8-bit value as defined in Table ‘Contents of a control lists’. Contents of a control lists Signal / Order / Decimal value of bits

  • Marker 1 Marker 2 Marker 3 / LSB / 1 2 4

  • Burst / LSB / 16

  • LevAtt1 / LSB / 32

  • CWMod / LSB / 64

  • Hop / MSB / 128

The data can also be sent as a binary block. Each binary block is a 2-byte value, in which the 16 bits represent the binary values (16-bit unsigned integer, 2 bytes, LSB first) . When binary data transmission is in use, use the command SYSTem:COMMunicate:GPIB:LTERminator EOI to set the termination character mode to ‘EOI control data message only’ so that a random LF in the data sequence is not interpreted as End, thereby prematurely terminating the data transmission. The command …LTER STAN resets the mode. According to the specifications, the byte sequence is defined as ‘most significant byte first’. Tip: Control lists are created in binary format. Use an ASCII format to create a waveform file with R&S WinIQSIM2. See also ‘Creating control lists with tag file format’. The command *RST has no effect on data lists.

Parameters:

data – string

set_select(filename: str) None[source]
# [SOURce<HW>]:BB:DM:CLISt:SELect
driver.source.bb.dm.clist.set_select(filename = 'abc')

Selects the specified list file from the default directory or in the directory specified with the complete file path. See also method RsSmw.massMemory.current_directory() . If a list with the specified name does not yet exist, it is created. The file extension can be omitted. See also ‘Handling files in the default or in a specified directory’. List type / Command / File extension

  • Data list / …:DLISt… / dm_iqd

  • Control list / …:CLISt… / dm_iqc

  • User standard / …:ULISt… / dm_stu

  • User filter files / …:FLISt… / vaf

  • User mapping lists / …:MLISt… / vam

Parameters:

filename – list name