OneFile

SCPI Commands :

SAVeset:ONEFile:NAME
SAVeset:ONEFile:SAVE
SAVeset:ONEFile:OPEN
SAVeset:ONEFile:USERpref

Commands in total: 4

Subgroups: 0

Direct child commands: 4

get_name() → str

# SAVeset:ONEFile:NAME
value: str = driver.saveset.oneFile.get_name()

Sets the path and the file name of the One File. The file format is ZIP.

get_user_pref() → bool

# SAVeset:ONEFile:USERpref
value: bool = driver.saveset.oneFile.get_user_pref()

If ON, the user preferences settings are also restored together with the saveset and reference waveform. User preferences settings include the user-specific display settings like diagram layout, toolbar, intensity and transparency settings.

open() → None

# SAVeset:ONEFile:OPEN
driver.saveset.oneFile.open()

Loads the One File that is specified with method RsRtx.saveset.oneFile.name() .

open_and_wait(opc_timeout_ms: int = -1) → None

# SAVeset:ONEFile:OPEN
driver.saveset.oneFile.open_and_wait()

Loads the One File that is specified with method RsRtx.saveset.oneFile.name() .

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

Parameters:

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

save() → None

# SAVeset:ONEFile:SAVE
driver.saveset.oneFile.save()

No help available

save_and_wait(opc_timeout_ms: int = -1) → None

# SAVeset:ONEFile:SAVE
driver.saveset.oneFile.save_and_wait()

No help available

Same as save, but waits for the operation to complete before continuing further. Use the RsRtx.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_name(path_one_file: str) → None

# SAVeset:ONEFile:NAME
driver.saveset.oneFile.set_name(path_one_file = 'abc')

Sets the path and the file name of the One File. The file format is ZIP.

Parameters:

path_one_file – String parameter

set_user_pref(include_usr_preferences_in_one_file: bool) → None

# SAVeset:ONEFile:USERpref
driver.saveset.oneFile.set_user_pref(include_usr_preferences_in_one_file = False)

If ON, the user preferences settings are also restored together with the saveset and reference waveform. User preferences settings include the user-specific display settings like diagram layout, toolbar, intensity and transparency settings.

Parameters:

include_usr_preferences_in_one_file – OFF | ON