Waypoint

SCPI Commands :

SCENario:LOCalized:RECeiver:MOVement:WAYPoint:CLEar
SCENario:LOCalized:RECeiver:MOVement:WAYPoint

class WaypointCls

Waypoint commands group definition. 2 total commands, 0 Subgroups, 2 group commands

clear() → None

# SCPI: SCENario:LOCalized:RECeiver:MOVement:WAYPoint:CLEar
driver.scenario.localized.receiver.movement.waypoint.clear()

Discards the selected file.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: SCENario:LOCalized:RECeiver:MOVement:WAYPoint:CLEar
driver.scenario.localized.receiver.movement.waypoint.clear_with_opc()

Discards the selected file.

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.

get_value() → str

# SCPI: SCENario:LOCalized:RECeiver:MOVement:WAYPoint
value: str = driver.scenario.localized.receiver.movement.waypoint.get_value()

Loads the selected waypoint file. To import and apply the files, send the command method RsPulseSeq.Scenario.Localized. Movement.ImportPy.set.

return:

waypoint: string Filename or complete file path, incl. file extension. Waypoint files must have the extension *.txt, *.kml or *.xtd. Example files are provided with the software. For description, see ‘Movement files’.

set_value(waypoint: str) → None

# SCPI: SCENario:LOCalized:RECeiver:MOVement:WAYPoint
driver.scenario.localized.receiver.movement.waypoint.set_value(waypoint = 'abc')

Loads the selected waypoint file. To import and apply the files, send the command method RsPulseSeq.Scenario.Localized. Movement.ImportPy.set.

param waypoint:

string Filename or complete file path, incl. file extension. Waypoint files must have the extension *.txt, *.kml or *.xtd. Example files are provided with the software. For description, see ‘Movement files’.