Scenario

SCPI Commands :

[SOURce<HW>]:AREGenerator:SCENario:PROGress
[SOURce<HW>]:AREGenerator:SCENario:RESet
[SOURce<HW>]:AREGenerator:SCENario:STARt
[SOURce<HW>]:AREGenerator:SCENario:STATus
[SOURce<HW>]:AREGenerator:SCENario:STOP

class ScenarioCls

Scenario commands group definition. 12 total commands, 4 Subgroups, 5 group commands

get_progress() → float

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:PROGress
value: float = driver.source.areGenerator.scenario.get_progress()

Queries the current position in time while playing the file. Query the current position via [:SOURce<hw>]:AREGenerator:SCENario:PROGress?.

return:

scenario_progres: float Range: 0 to 100

get_status() → ScenarioStatus

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:STATus
value: enums.ScenarioStatus = driver.source.areGenerator.scenario.get_status()

Queries the status of the played scenario file.

return:

scenario_status: RUNNing| STOPped RUNNing The replay of the scenario is ongoing. STOPped The replay of the scenario is stopped.

reset() → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:RESet
driver.source.areGenerator.scenario.reset()

Resets the Start, Stop and Position parameters of the replayed scenario.

reset_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:RESet
driver.source.areGenerator.scenario.reset_with_opc()

Resets the Start, Stop and Position parameters of the replayed scenario.

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

param opc_timeout_ms:

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

set_progress(scenario_progres: float) → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:PROGress
driver.source.areGenerator.scenario.set_progress(scenario_progres = 1.0)

Queries the current position in time while playing the file. Query the current position via [:SOURce<hw>]:AREGenerator:SCENario:PROGress?.

param scenario_progres:

float Range: 0 to 100

set_status(scenario_status: ScenarioStatus) → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:STATus
driver.source.areGenerator.scenario.set_status(scenario_status = enums.ScenarioStatus.RUNNing)

Queries the status of the played scenario file.

param scenario_status:

RUNNing| STOPped RUNNing The replay of the scenario is ongoing. STOPped The replay of the scenario is stopped.

start() → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:STARt
driver.source.areGenerator.scenario.start()

Starts the player. Plays the scenario file from the beginning.

start_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:STARt
driver.source.areGenerator.scenario.start_with_opc()

Starts the player. Plays the scenario file from the beginning.

Same as start, but waits for the operation to complete before continuing further. Use the RsAreg800.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

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:STOP
driver.source.areGenerator.scenario.stop()

Stops the player. After stopping, you can resume playing by [:SOURce<hw>]:AREGenerator:SCENario:STARt. The file plays from the start position.

stop_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: [SOURce<HW>]:AREGenerator:SCENario:STOP
driver.source.areGenerator.scenario.stop_with_opc()

Stops the player. After stopping, you can resume playing by [:SOURce<hw>]:AREGenerator:SCENario:STARt. The file plays from the start position.

Same as stop, but waits for the operation to complete before continuing further. Use the RsAreg800.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.source.areGenerator.scenario.clone()

Subgroups

• File
• Pause
• Position
• Replay