Plugin

SCPI Commands :

PLUGin:CATalog
PLUGin:COMMent
PLUGin:CREate
PLUGin:LOAD
PLUGin:NAME
PLUGin:REMove
PLUGin:SELect

class PluginCls

Plugin commands group definition. 13 total commands, 1 Subgroups, 7 group commands

get_catalog() → str

# SCPI: PLUGin:CATalog
value: str = driver.plugin.get_catalog()

Queries the available repository elements in the database.

return:

catalog: string

get_comment() → str

# SCPI: PLUGin:COMMent
value: str = driver.plugin.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_name() → str

# SCPI: PLUGin:NAME
value: str = driver.plugin.get_name()

Renames the selected repository element.

return:

name: string Must be unique for the particular type of repository elements. May contain empty spaces.

get_select() → str

# SCPI: PLUGin:SELect
value: str = driver.plugin.get_select()

Selects the repository element to which the subsequent commands apply.

return:

select: string Element name, as defined with the …:CREate or …:NAME command. To query the existing elements, use the …:CATalog? command. For example, method RsPulseSeq.Repository.catalog.

load(load: str) → None

# SCPI: PLUGin:LOAD
driver.plugin.load(load = 'abc')

Loads the selected DLL file, see also ‘Plug-in programming API’.

param load:

string File path incl. file name and extension

set_comment(comment: str) → None

# SCPI: PLUGin:COMMent
driver.plugin.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_create(create: str) → None

# SCPI: PLUGin:CREate
driver.plugin.set_create(create = 'abc')

Creates a repository element with the selected name.

param create:

string Must be unique for the particular type of repository elements. May contain empty spaces.

set_name(name: str) → None

# SCPI: PLUGin:NAME
driver.plugin.set_name(name = 'abc')

Renames the selected repository element.

param name:

string Must be unique for the particular type of repository elements. May contain empty spaces.

set_remove(remove: str) → None

# SCPI: PLUGin:REMove
driver.plugin.set_remove(remove = 'abc')

Removes the selected element from the workspace. The element must not reference any child elements. Remove the referenced elements first.

param remove:

No help available

set_select(select: str) → None

# SCPI: PLUGin:SELect
driver.plugin.set_select(select = 'abc')

Selects the repository element to which the subsequent commands apply.

param select:

string Element name, as defined with the …:CREate or …:NAME command. To query the existing elements, use the …:CATalog? command. For example, method RsPulseSeq.Repository.catalog.

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.plugin.clone()

Subgroups

• Module