Group

SCPI Commands :

SCENario:CPDW:GROup:ALIas
SCENario:CPDW:GROup:CATalog
SCENario:CPDW:GROup:CLEar
SCENario:CPDW:GROup:COUNt
SCENario:CPDW:GROup:DELete
SCENario:CPDW:GROup:SELect
SCENario:CPDW:GROup

class GroupCls

Group commands group definition. 8 total commands, 1 Subgroups, 7 group commands

clear() → None

# SCPI: SCENario:CPDW:GROup:CLEar
driver.scenario.cpdw.group.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: SCENario:CPDW:GROup:CLEar
driver.scenario.cpdw.group.clear_with_opc()

Deletes all items from the list or the table.

Same as clear, but waits for the operation to complete before continuing further. Use the RsPulseSeq.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

delete(delete: float) → None

# SCPI: SCENario:CPDW:GROup:DELete
driver.scenario.cpdw.group.delete(delete = 1.0)

Deletes the particular item.

param delete:

float

get_alias() → str

# SCPI: SCENario:CPDW:GROup:ALIas
value: str = driver.scenario.cpdw.group.get_alias()

Sets an alias name for the selected interleaving group. See also method RsPulseSeq.Assignment.Group.select.

return:

alias: string

get_catalog() → str

# SCPI: SCENario:CPDW:GROup:CATalog
value: str = driver.scenario.cpdw.group.get_catalog()

Queries the alias names of the configured interleaving groups.

return:

catalog: string A list of coma-separated alias names.

get_count() → float

# SCPI: SCENario:CPDW:GROup:COUNt
value: float = driver.scenario.cpdw.group.get_count()

Queries the number of existing items.

return:

count: integer

get_select() → float

# SCPI: SCENario:CPDW:GROup:SELect
value: float = driver.scenario.cpdw.group.get_select()

Selects the item to which the subsequent commands apply.

return:

select: float Item number within the range 1 to …:COUNt. For example, method RsPulseSeq.Sequence.Item.count. Range: 1 to 4096

get_value() → str

# SCPI: SCENario:CPDW:GROup
value: str = driver.scenario.cpdw.group.get_value()

Assigns the emitter to one of the available interleaving groups.

return:

group: string Query a list of the alias names of the existing interleaving groups with the command method RsPulseSeq.Scenario.Cpdw.Group.catalog.

set_alias(alias: str) → None

# SCPI: SCENario:CPDW:GROup:ALIas
driver.scenario.cpdw.group.set_alias(alias = 'abc')

Sets an alias name for the selected interleaving group. See also method RsPulseSeq.Assignment.Group.select.

param alias:

string

set_select(select: float) → None

# SCPI: SCENario:CPDW:GROup:SELect
driver.scenario.cpdw.group.set_select(select = 1.0)

Selects the item to which the subsequent commands apply.

param select:

float Item number within the range 1 to …:COUNt. For example, method RsPulseSeq.Sequence.Item.count. Range: 1 to 4096

set_value(group: str) → None

# SCPI: SCENario:CPDW:GROup
driver.scenario.cpdw.group.set_value(group = 'abc')

Assigns the emitter to one of the available interleaving groups.

param group:

string Query a list of the alias names of the existing interleaving groups with the command method RsPulseSeq.Scenario.Cpdw.Group.catalog.

Cloning the Group

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

Subgroups

• Add