Apool

SCPI Commands :

SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:VALid
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:LOADed
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:RREQuired
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:RTOTal
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:FILE
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:REMove
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:CLEar
SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:MINDex

class ApoolCls[source]

Apool commands group definition. 32 total commands, 13 Subgroups, 8 group commands

clear() → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:CLEar
driver.source.gprf.generator.sequencer.apool.clear()

Removes all files from the ARB file pool.

clear_with_opc(opc_timeout_ms: int = -1) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:CLEar
driver.source.gprf.generator.sequencer.apool.clear_with_opc()

Removes all files from the ARB file pool.

Same as clear, but waits for the operation to complete before continuing further. Use the RsCMPX_Gprf.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_loaded() → YesNoStatus[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:LOADed
value: enums.YesNoStatus = driver.source.gprf.generator.sequencer.apool.get_loaded()

Queries whether the ARB file pool is downloaded to the ARB RAM.

return:

loaded: No help available

get_mindex() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:MINDex
value: int = driver.source.gprf.generator.sequencer.apool.get_mindex()

Queries the highest index of the ARB file pool. The pool contains files with the indices 0 to <MaximumIndex>.

return:

maximum_index: Highest index. If the file pool is empty, NAV is returned.

get_rrequired() → float[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:RREQuired
value: float = driver.source.gprf.generator.sequencer.apool.get_rrequired()

Queries the amount of RAM required by the ARB files in the pool.

return:

ram_required: No help available

get_rtotal() → float[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:RTOTal
value: float = driver.source.gprf.generator.sequencer.apool.get_rtotal()

Queries the amount of RAM available for ARB files.

return:

ram_total: No help available

get_valid() → YesNoStatus[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:VALid
value: enums.YesNoStatus = driver.source.gprf.generator.sequencer.apool.get_valid()

Queries whether the ARB file pool is valid.

return:

valid: No help available

set_file(arb_file: str) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:FILE
driver.source.gprf.generator.sequencer.apool.set_file(arb_file = 'abc')

Adds an ARB file to the ARB file pool.

param arb_file:

Path and filename Example: ‘@WAVEFORM/myARBfile.wv’

set_remove(indices: List[int]) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:APOol:REMove
driver.source.gprf.generator.sequencer.apool.set_remove(indices = [1, 2, 3])

Removes selected files from the ARB file pool.

param indices:

Indices of the files to be removed. You can specify a single index or a comma-separated list of indices.

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.gprf.generator.sequencer.apool.clone()

Subgroups