Throughput¶
SCPI Commands
CONFigure:GSM:SIGNaling<Instance>:THRoughput:TOUT
CONFigure:GSM:SIGNaling<Instance>:THRoughput:WINDow
CONFigure:GSM:SIGNaling<Instance>:THRoughput:REPetition
- class Throughput[source]
Throughput commands group definition. 3 total commands, 0 Sub-groups, 3 group commands
- get_repetition() → RsCmwGsmSig.enums.Repeat[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:THRoughput:REPetition value: enums.Repeat = driver.configure.throughput.get_repetition()
Specifies the repetition mode of the measurement. The repetition mode specifies whether the measurement is stopped after a single-shot or repeated continuously. Use method RsCmwGsmSig.Configure.Throughput.window to configure the duration of a single shot.
- return
repetition: SINGleshot | CONTinuous SINGleshot: Single-shot measurement CONTinuous: Continuous measurement
- get_timeout() → float[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:THRoughput:TOUT value: float = driver.configure.throughput.get_timeout()
Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated manually ([ON | OFF] key or [RESTART | STOP] key) . When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.
- return
timeout: Unit: s
- get_window() → int[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:THRoughput:WINDow value: int = driver.configure.throughput.get_window()
Specifies the duration of a single-shot measurement, i.e. the time interval covered by a throughput result trace. The value is internally rounded up to the next integer multiple of the time interval used to calculate a single result (240 ms) .
- return
size: Range: 10 s to 240 s, Unit: s
- set_repetition(repetition: RsCmwGsmSig.enums.Repeat) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:THRoughput:REPetition driver.configure.throughput.set_repetition(repetition = enums.Repeat.CONTinuous)
Specifies the repetition mode of the measurement. The repetition mode specifies whether the measurement is stopped after a single-shot or repeated continuously. Use method RsCmwGsmSig.Configure.Throughput.window to configure the duration of a single shot.
- param repetition
SINGleshot | CONTinuous SINGleshot: Single-shot measurement CONTinuous: Continuous measurement
- set_timeout(timeout: float) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:THRoughput:TOUT driver.configure.throughput.set_timeout(timeout = 1.0)
Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated manually ([ON | OFF] key or [RESTART | STOP] key) . When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.
- param timeout
Unit: s
- set_window(size: int) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:THRoughput:WINDow driver.configure.throughput.set_window(size = 1)
Specifies the duration of a single-shot measurement, i.e. the time interval covered by a throughput result trace. The value is internally rounded up to the next integer multiple of the time interval used to calculate a single result (240 ms) .
- param size
Range: 10 s to 240 s, Unit: s