Scenario

SCPI Commands :

SCENario:CATalog
SCENario:COMMent
SCENario:CREate
SCENario:ID
SCENario:NAME
SCENario:REMove
SCENario:SANitize
SCENario:SELect
SCENario:STARt
SCENario:STATe
SCENario:STOP
SCENario:TYPE
SCENario:WAVeform
class ScenarioCls[source]

Scenario commands group definition. 461 total commands, 17 Subgroups, 13 group commands

get_catalog() → str[source]
# SCPI: SCENario:CATalog
value: str = driver.scenario.get_catalog()

Queries the available repository elements in the database.

return:

catalog: string

get_comment() → str[source]
# SCPI: SCENario:COMMent
value: str = driver.scenario.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_id() → float[source]
# SCPI: SCENario:ID
value: float = driver.scenario.get_id()

Queries the database identifier of the selected scenario.

return:

idn: float

get_name() → str[source]
# SCPI: SCENario:NAME
value: str = driver.scenario.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[source]
# SCPI: SCENario:SELect
value: str = driver.scenario.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.

get_state() → State[source]
# SCPI: SCENario:STATe
value: enums.State = driver.scenario.get_state()

Queries the current scenario status.

return:

state: IDLE| RUN

get_type_py() → ScenarioType[source]
# SCPI: SCENario:TYPE
value: enums.ScenarioType = driver.scenario.get_type_py()

Sets the scenario type.

return:

type_py: SEQuence| CSEQuence| EMITter| CEMitter| LOCalized| DF| PDW | WAVeform

get_waveform() → str[source]
# SCPI: SCENario:WAVeform
value: str = driver.scenario.get_waveform()

Specify the name of the ‘Signal Generation’ output file.

return:

waveform: string

set_comment(comment: str) → None[source]
# SCPI: SCENario:COMMent
driver.scenario.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_create(create: str) → None[source]
# SCPI: SCENario:CREate
driver.scenario.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[source]
# SCPI: SCENario:NAME
driver.scenario.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[source]
# SCPI: SCENario:REMove
driver.scenario.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_sanitize(sanitize: SanitizeScenario) → None[source]
# SCPI: SCENario:SANitize
driver.scenario.set_sanitize(sanitize = enums.SanitizeScenario.ALL)

Removes uploaded waveforms from the hard disk of the signal generator.

param sanitize:

SCENario| REPository| ALL SCENario Removes the current scenario waveforms REPository Removes the waveforms of all scenarios from the current repository ALL Removes all waveforms created by the R&S Pulse Sequencer

set_select(select: str) → None[source]
# SCPI: SCENario:SELect
driver.scenario.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.

set_type_py(type_py: ScenarioType) → None[source]
# SCPI: SCENario:TYPE
driver.scenario.set_type_py(type_py = enums.ScenarioType.CEMitter)

Sets the scenario type.

param type_py:

SEQuence| CSEQuence| EMITter| CEMitter| LOCalized| DF| PDW | WAVeform

set_waveform(waveform: str) → None[source]
# SCPI: SCENario:WAVeform
driver.scenario.set_waveform(waveform = 'abc')

Specify the name of the ‘Signal Generation’ output file.

param waveform:

string

start() → None[source]
# SCPI: SCENario:STARt
driver.scenario.start()

Starts the signal generation.

start_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: SCENario:STARt
driver.scenario.start_with_opc()

Starts the signal generation.

Same as start, 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.

stop() → None[source]
# SCPI: SCENario:STOP
driver.scenario.stop()

Stops the signal calculation.

stop_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: SCENario:STOP
driver.scenario.stop_with_opc()

Stops the signal calculation.

Same as stop, 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.

Cloning the Group

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

Subgroups