Regenerator

SCPI Commands :

[SOURce<HW>]:REGenerator:CATalog
[SOURce<HW>]:REGenerator:LOAD
[SOURce<HW>]:REGenerator:PRESet
[SOURce<HW>]:REGenerator:STORe
[SOURce<HW>]:REGenerator:[STATe]
Commands in total: 79
Subgroups: 7
Direct child commands: 5
get_catalog() → List[str][source]
# [SOURce<HW>]:REGenerator:CATalog
value: List[str] = driver.source.regenerator.get_catalog()

Queries the files with settings in the default directory. Listed are files with the file extension reg. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

Returns:

filenames: filename1,filename2,… Returns a string of file names separated by commas.

get_state() → bool[source]
# [SOURce<HW>]:REGenerator:[STATe]
value: bool = driver.source.regenerator.get_state()

Enables/disables the Radar Echo Generation.

Returns:

state: 1 | ON | 0| OFF

load(filename: str) → None[source]
# [SOURce<HW>]:REGenerator:LOAD
driver.source.regenerator.load(filename = 'abc')

Loads the selected file from the default or the specified directory. Loaded are files with extension reg. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

Parameters:

filename – string file name or complete file path; file extension can be omitted

preset() → None[source]
# [SOURce<HW>]:REGenerator:PRESet
driver.source.regenerator.preset()

Calls the default settings.

preset_with_opc(opc_timeout_ms: int = -1) → None[source]
# [SOURce<HW>]:REGenerator:PRESet
driver.source.regenerator.preset_with_opc()

Calls the default settings.

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

Parameters:

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

set_state(state: bool) → None[source]
# [SOURce<HW>]:REGenerator:[STATe]
driver.source.regenerator.set_state(state = False)

Enables/disables the Radar Echo Generation.

Parameters:

state – 1 | ON | 0| OFF

set_store(filename: str) → None[source]
# [SOURce<HW>]:REGenerator:STORe
driver.source.regenerator.set_store(filename = 'abc')

Stores the current settings into the selected file; the file extension (reg) is assigned automatically. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

Parameters:

filename – string

Cloning the Group

# Create a copy of the original group, that exists independently
regenerator_copy = driver.source.regenerator.clone()

Subgroups