from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class GsCls:
"""Gs commands group definition. 14 total commands, 0 Subgroups, 14 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("gs", core, parent)
# noinspection PyTypeChecker
[docs] def get_ant_subset(self) -> enums.EutraTcwaNtSubset:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:ANTSubset \n
Snippet: value: enums.EutraTcwaNtSubset = driver.source.bb.eutra.tcw.gs.get_ant_subset() \n
Enabled for test setups with eight Rx antennas Determines the signal of which antenna couple, Antenna 1 and 2 (AS12) ,
Antenna 3 and 4 (AS34) , Antenna 5 and 6 (AS56) or Antenna 7 and 8 (AS78) , is generated by the instrument. \n
:return: antenna_subset: AS34| AS12| ALL| AS56| AS78
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:ANTSubset?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwaNtSubset)
[docs] def set_ant_subset(self, antenna_subset: enums.EutraTcwaNtSubset) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:ANTSubset \n
Snippet: driver.source.bb.eutra.tcw.gs.set_ant_subset(antenna_subset = enums.EutraTcwaNtSubset.ALL) \n
Enabled for test setups with eight Rx antennas Determines the signal of which antenna couple, Antenna 1 and 2 (AS12) ,
Antenna 3 and 4 (AS34) , Antenna 5 and 6 (AS56) or Antenna 7 and 8 (AS78) , is generated by the instrument. \n
:param antenna_subset: AS34| AS12| ALL| AS56| AS78
"""
param = Conversions.enum_scalar_to_str(antenna_subset, enums.EutraTcwaNtSubset)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:ANTSubset {param}')
# noinspection PyTypeChecker
[docs] def get_bs_class(self) -> enums.UtraTcwbSclass:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:BSCLass \n
Snippet: value: enums.UtraTcwbSclass = driver.source.bb.eutra.tcw.gs.get_bs_class() \n
Sets the base station class. \n
:return: bs_class: WIDE| LOCal| HOME| MEDium
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:BSCLass?')
return Conversions.str_to_scalar_enum(response, enums.UtraTcwbSclass)
[docs] def set_bs_class(self, bs_class: enums.UtraTcwbSclass) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:BSCLass \n
Snippet: driver.source.bb.eutra.tcw.gs.set_bs_class(bs_class = enums.UtraTcwbSclass.HOME) \n
Sets the base station class. \n
:param bs_class: WIDE| LOCal| HOME| MEDium
"""
param = Conversions.enum_scalar_to_str(bs_class, enums.UtraTcwbSclass)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:BSCLass {param}')
# noinspection PyTypeChecker
[docs] def get_gen_signals(self) -> enums.EutraTcwGeneratedSig:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:GENSignals \n
Snippet: value: enums.EutraTcwGeneratedSig = driver.source.bb.eutra.tcw.gs.get_gen_signals() \n
Determines the signal generated by the instrument. \n
:return: generated_signal: WSIF1AWGN| IF23| ALL| WSUE1UE2AWGN| WSUE3UE4| IF WSIF1AWGN Wanted Signal, Interferer 1 and AWGN only; required in test setup with two instruments IF23 Interferes 2 and 3 only; required in test setup with two instruments ALL The instrument generates all required signals WSUE1UE2AWGN Only Wanted Signal UE 1, Wanted Signal UE 2 and AWGN WSUE3UE4 Only Wanted Signal UE 3 and Wanted Signal UE 4 IF Interferer signal only
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:GENSignals?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwGeneratedSig)
[docs] def set_gen_signals(self, generated_signal: enums.EutraTcwGeneratedSig) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:GENSignals \n
Snippet: driver.source.bb.eutra.tcw.gs.set_gen_signals(generated_signal = enums.EutraTcwGeneratedSig.ALL) \n
Determines the signal generated by the instrument. \n
:param generated_signal: WSIF1AWGN| IF23| ALL| WSUE1UE2AWGN| WSUE3UE4| IF WSIF1AWGN Wanted Signal, Interferer 1 and AWGN only; required in test setup with two instruments IF23 Interferes 2 and 3 only; required in test setup with two instruments ALL The instrument generates all required signals WSUE1UE2AWGN Only Wanted Signal UE 1, Wanted Signal UE 2 and AWGN WSUE3UE4 Only Wanted Signal UE 3 and Wanted Signal UE 4 IF Interferer signal only
"""
param = Conversions.enum_scalar_to_str(generated_signal, enums.EutraTcwGeneratedSig)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:GENSignals {param}')
# noinspection PyTypeChecker
[docs] def get_inst_setup(self) -> enums.EutraTcwiNstSetup:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:INSTsetup \n
Snippet: value: enums.EutraTcwiNstSetup = driver.source.bb.eutra.tcw.gs.get_inst_setup() \n
Determines whether one or both paths are used. \n
:return: instrument_setup: U2PATH| U1PATH
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:INSTsetup?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwiNstSetup)
[docs] def set_inst_setup(self, instrument_setup: enums.EutraTcwiNstSetup) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:INSTsetup \n
Snippet: driver.source.bb.eutra.tcw.gs.set_inst_setup(instrument_setup = enums.EutraTcwiNstSetup.U1PATH) \n
Determines whether one or both paths are used. \n
:param instrument_setup: U2PATH| U1PATH
"""
param = Conversions.enum_scalar_to_str(instrument_setup, enums.EutraTcwiNstSetup)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:INSTsetup {param}')
# noinspection PyTypeChecker
[docs] def get_marker_config(self) -> enums.EutraTcwMarkConf:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:MARKerconfig \n
Snippet: value: enums.EutraTcwMarkConf = driver.source.bb.eutra.tcw.gs.get_marker_config() \n
Selects the marker configuration. The marker can be used to synchronize the measuring equipment to the signal generator. \n
:return: marker_config: UNCHanged| FRAMe FRAMe The marker settings are customized for the selected test case. 'Radio Frame Start' markers are output; the marker delays are set equal to zero. UNCHanged The current marker settings of the signal generator are retained unchanged.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:MARKerconfig?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwMarkConf)
[docs] def set_marker_config(self, marker_config: enums.EutraTcwMarkConf) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:MARKerconfig \n
Snippet: driver.source.bb.eutra.tcw.gs.set_marker_config(marker_config = enums.EutraTcwMarkConf.FRAMe) \n
Selects the marker configuration. The marker can be used to synchronize the measuring equipment to the signal generator. \n
:param marker_config: UNCHanged| FRAMe FRAMe The marker settings are customized for the selected test case. 'Radio Frame Start' markers are output; the marker delays are set equal to zero. UNCHanged The current marker settings of the signal generator are retained unchanged.
"""
param = Conversions.enum_scalar_to_str(marker_config, enums.EutraTcwMarkConf)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:MARKerconfig {param}')
# noinspection PyTypeChecker
[docs] def get_mode(self) -> enums.EutraTcwGsModeDefaultRange:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:MODE \n
Snippet: value: enums.EutraTcwGsModeDefaultRange = driver.source.bb.eutra.tcw.gs.get_mode() \n
Determines the measurements type, Pfa or Pd, the signal is generated for, see 'Mode'. \n
:return: mode: DRATe| FDRate| ADRate FDRate False Detection Rate (Pfa) DRATe Detection Rate (Pd) ADRate Alternating Pd and Pfa
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:MODE?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwGsModeDefaultRange)
[docs] def set_mode(self, mode: enums.EutraTcwGsModeDefaultRange) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:MODE \n
Snippet: driver.source.bb.eutra.tcw.gs.set_mode(mode = enums.EutraTcwGsModeDefaultRange.ADRate) \n
Determines the measurements type, Pfa or Pd, the signal is generated for, see 'Mode'. \n
:param mode: DRATe| FDRate| ADRate FDRate False Detection Rate (Pfa) DRATe Detection Rate (Pd) ADRate Alternating Pd and Pfa
"""
param = Conversions.enum_scalar_to_str(mode, enums.EutraTcwGsModeDefaultRange)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:MODE {param}')
# noinspection PyTypeChecker
[docs] def get_option(self) -> enums.UtraTcwgsoPtion:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:OPTion \n
Snippet: value: enums.UtraTcwgsoPtion = driver.source.bb.eutra.tcw.gs.get_option() \n
Selects one of the two test case options. \n
:return: option: OPT1| OPT2
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:OPTion?')
return Conversions.str_to_scalar_enum(response, enums.UtraTcwgsoPtion)
[docs] def set_option(self, option: enums.UtraTcwgsoPtion) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:OPTion \n
Snippet: driver.source.bb.eutra.tcw.gs.set_option(option = enums.UtraTcwgsoPtion.OPT1) \n
Selects one of the two test case options. \n
:param option: OPT1| OPT2
"""
param = Conversions.enum_scalar_to_str(option, enums.UtraTcwgsoPtion)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:OPTion {param}')
# noinspection PyTypeChecker
[docs] def get_release(self) -> enums.EutraTcwRelease:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:RELease \n
Snippet: value: enums.EutraTcwRelease = driver.source.bb.eutra.tcw.gs.get_release() \n
Sets the 3GPP test specification used as a guideline for the test cases. \n
:return: release: REL8| REL9| REL10| REL11 | REL12| REL13TO15
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:RELease?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwRelease)
[docs] def set_release(self, release: enums.EutraTcwRelease) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:RELease \n
Snippet: driver.source.bb.eutra.tcw.gs.set_release(release = enums.EutraTcwRelease.REL10) \n
Sets the 3GPP test specification used as a guideline for the test cases. \n
:param release: REL8| REL9| REL10| REL11 | REL12| REL13TO15
"""
param = Conversions.enum_scalar_to_str(release, enums.EutraTcwRelease)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:RELease {param}')
# noinspection PyTypeChecker
[docs] def get_rx_antennas(self) -> enums.EutraTcwNumOfRxAnt:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:RXANtennas \n
Snippet: value: enums.EutraTcwNumOfRxAnt = driver.source.bb.eutra.tcw.gs.get_rx_antennas() \n
For performance requirement tests, determines the number of the Rx antennas. \n
:return: num_of_rx_antennas: ANT4| ANT2| ANT1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:RXANtennas?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwNumOfRxAnt)
[docs] def set_rx_antennas(self, num_of_rx_antennas: enums.EutraTcwNumOfRxAnt) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:RXANtennas \n
Snippet: driver.source.bb.eutra.tcw.gs.set_rx_antennas(num_of_rx_antennas = enums.EutraTcwNumOfRxAnt.ANT1) \n
For performance requirement tests, determines the number of the Rx antennas. \n
:param num_of_rx_antennas: ANT4| ANT2| ANT1
"""
param = Conversions.enum_scalar_to_str(num_of_rx_antennas, enums.EutraTcwNumOfRxAnt)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:RXANtennas {param}')
# noinspection PyTypeChecker
[docs] def get_sig_rout(self) -> enums.EutraTcwSignalRout:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:SIGRout \n
Snippet: value: enums.EutraTcwSignalRout = driver.source.bb.eutra.tcw.gs.get_sig_rout() \n
Selects the signal routing for baseband A signal which usually represents the wanted signal. \n
:return: signal_routing: PORTA | PORTB
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:SIGRout?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwSignalRout)
[docs] def set_sig_rout(self, signal_routing: enums.EutraTcwSignalRout) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:SIGRout \n
Snippet: driver.source.bb.eutra.tcw.gs.set_sig_rout(signal_routing = enums.EutraTcwSignalRout.PORTA) \n
Selects the signal routing for baseband A signal which usually represents the wanted signal. \n
:param signal_routing: PORTA | PORTB
"""
param = Conversions.enum_scalar_to_str(signal_routing, enums.EutraTcwSignalRout)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:SIGRout {param}')
# noinspection PyTypeChecker
[docs] def get_spec(self) -> enums.UtraTcwsPec:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:SPEC \n
Snippet: value: enums.UtraTcwsPec = driver.source.bb.eutra.tcw.gs.get_spec() \n
Selects the 3GPP test specification used as a guideline for the test cases. \n
:return: gs_spec: TS36141
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:SPEC?')
return Conversions.str_to_scalar_enum(response, enums.UtraTcwsPec)
[docs] def set_spec(self, gs_spec: enums.UtraTcwsPec) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:SPEC \n
Snippet: driver.source.bb.eutra.tcw.gs.set_spec(gs_spec = enums.UtraTcwsPec.TS36141) \n
Selects the 3GPP test specification used as a guideline for the test cases. \n
:param gs_spec: TS36141
"""
param = Conversions.enum_scalar_to_str(gs_spec, enums.UtraTcwsPec)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:SPEC {param}')
# noinspection PyTypeChecker
[docs] def get_stc(self) -> enums.UtraTcwgssUbtest:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:STC \n
Snippet: value: enums.UtraTcwgssUbtest = driver.source.bb.eutra.tcw.gs.get_stc() \n
Selects the subtest case. \n
:return: sub_test_case: STC1| STC2| STC4| STC3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:STC?')
return Conversions.str_to_scalar_enum(response, enums.UtraTcwgssUbtest)
[docs] def set_stc(self, sub_test_case: enums.UtraTcwgssUbtest) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:STC \n
Snippet: driver.source.bb.eutra.tcw.gs.set_stc(sub_test_case = enums.UtraTcwgssUbtest.STC1) \n
Selects the subtest case. \n
:param sub_test_case: STC1| STC2| STC4| STC3
"""
param = Conversions.enum_scalar_to_str(sub_test_case, enums.UtraTcwgssUbtest)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:STC {param}')
# noinspection PyTypeChecker
[docs] def get_trigger_config(self) -> enums.EutraTcwtRigConf:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:TRIGgerconfig \n
Snippet: value: enums.EutraTcwtRigConf = driver.source.bb.eutra.tcw.gs.get_trigger_config() \n
Selects the trigger configuration. The trigger is used to synchronize the signal generator to the other equipment. \n
:return: trigger_config: UNCHanged| AAUTo UNCHanged The current trigger settings of the signal generator are retained unchanged. AAUTo The trigger settings are customized for the selected test case. The trigger setting 'Armed Auto' with external trigger source is used; the trigger delay is set to zero. Thus, the base station frame timing is able to synchronize the signal generator by a periodic trigger.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:TRIGgerconfig?')
return Conversions.str_to_scalar_enum(response, enums.EutraTcwtRigConf)
[docs] def set_trigger_config(self, trigger_config: enums.EutraTcwtRigConf) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:TRIGgerconfig \n
Snippet: driver.source.bb.eutra.tcw.gs.set_trigger_config(trigger_config = enums.EutraTcwtRigConf.AAUTo) \n
Selects the trigger configuration. The trigger is used to synchronize the signal generator to the other equipment. \n
:param trigger_config: UNCHanged| AAUTo UNCHanged The current trigger settings of the signal generator are retained unchanged. AAUTo The trigger settings are customized for the selected test case. The trigger setting 'Armed Auto' with external trigger source is used; the trigger delay is set to zero. Thus, the base station frame timing is able to synchronize the signal generator by a periodic trigger.
"""
param = Conversions.enum_scalar_to_str(trigger_config, enums.EutraTcwtRigConf)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:TRIGgerconfig {param}')
# noinspection PyTypeChecker
[docs] def get_tx_antennas(self) -> enums.TxAntenna:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:TXANtennas \n
Snippet: value: enums.TxAntenna = driver.source.bb.eutra.tcw.gs.get_tx_antennas() \n
For performance requirement tests, determines the number of the Tx antennas. \n
:return: num_of_tx_antennas: ANT1| ANT2
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:TCW:GS:TXANtennas?')
return Conversions.str_to_scalar_enum(response, enums.TxAntenna)
[docs] def set_tx_antennas(self, num_of_tx_antennas: enums.TxAntenna) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:TCW:GS:TXANtennas \n
Snippet: driver.source.bb.eutra.tcw.gs.set_tx_antennas(num_of_tx_antennas = enums.TxAntenna.ANT1) \n
For performance requirement tests, determines the number of the Tx antennas. \n
:param num_of_tx_antennas: ANT1| ANT2
"""
param = Conversions.enum_scalar_to_str(num_of_tx_antennas, enums.TxAntenna)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:TCW:GS:TXANtennas {param}')