from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from .......Internal.StructBase import StructBase
from .......Internal.ArgStruct import ArgStruct
from ....... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class TpcCls:
"""Tpc commands group definition. 8 total commands, 3 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("tpc", core, parent)
@property
def pexecute(self):
"""pexecute commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_pexecute'):
from .Pexecute import PexecuteCls
self._pexecute = PexecuteCls(self._core, self._cmd_group)
return self._pexecute
@property
def single(self):
"""single commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_single'):
from .Single import SingleCls
self._single = SingleCls(self._core, self._cmd_group)
return self._single
@property
def cltPower(self):
"""cltPower commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_cltPower'):
from .CltPower import CltPowerCls
self._cltPower = CltPowerCls(self._core, self._cmd_group)
return self._cltPower
# noinspection PyTypeChecker
[docs]
def get_set(self) -> enums.SetType:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:SET \n
Snippet: value: enums.SetType = driver.configure.uplink.seta.pusch.tpc.get_set() \n
Selects the active TPC setup to be executed for power control of the PUSCH. For some TPC setups, the execution must be
explicitly triggered via method RsCmwLteSig.Configure.Uplink.Pcc.Pusch.Tpc.Pexecute.set. \n
:return: set_type: MINPower | MAXPower | CONStant | SINGle | UDSingle | UDContinuous | ALT0 | CLOop | RPControl | FULPower MINPower: command the UE to minimum power MAXPower: command the UE to maximum power CONStant: command the UE to keep the power constant SINGle: send a pattern once (only one type of TPC command) UDSingle: send a pattern once (mixed TPC commands allowed) UDContinuous: send a pattern continuously ALT0: send an alternating pattern continuously CLOop: command the UE to a configurable target power RPControl: patterns for 3GPP relative power control test FULPower: flexible uplink power
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:SET?')
return Conversions.str_to_scalar_enum(response, enums.SetType)
[docs]
def set_set(self, set_type: enums.SetType) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:SET \n
Snippet: driver.configure.uplink.seta.pusch.tpc.set_set(set_type = enums.SetType.ALT0) \n
Selects the active TPC setup to be executed for power control of the PUSCH. For some TPC setups, the execution must be
explicitly triggered via method RsCmwLteSig.Configure.Uplink.Pcc.Pusch.Tpc.Pexecute.set. \n
:param set_type: MINPower | MAXPower | CONStant | SINGle | UDSingle | UDContinuous | ALT0 | CLOop | RPControl | FULPower MINPower: command the UE to minimum power MAXPower: command the UE to maximum power CONStant: command the UE to keep the power constant SINGle: send a pattern once (only one type of TPC command) UDSingle: send a pattern once (mixed TPC commands allowed) UDContinuous: send a pattern continuously ALT0: send an alternating pattern continuously CLOop: command the UE to a configurable target power RPControl: patterns for 3GPP relative power control test FULPower: flexible uplink power
"""
param = Conversions.enum_scalar_to_str(set_type, enums.SetType)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:SET {param}')
# noinspection PyTypeChecker
[docs]
def get_rp_control(self) -> enums.RpControlPattern:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:RPControl \n
Snippet: value: enums.RpControlPattern = driver.configure.uplink.seta.pusch.tpc.get_rp_control() \n
Selects a TPC pattern for 3GPP relative power control tests with the TPC setup RPControl. \n
:return: pattern: RUA | RDA | RUB | RDB | RUC | RDC RUA | RUB | RUC: ramping up A | B | C RDA | RDB | RDC: ramping down A | B | C
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:RPControl?')
return Conversions.str_to_scalar_enum(response, enums.RpControlPattern)
[docs]
def set_rp_control(self, pattern: enums.RpControlPattern) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:RPControl \n
Snippet: driver.configure.uplink.seta.pusch.tpc.set_rp_control(pattern = enums.RpControlPattern.RDA) \n
Selects a TPC pattern for 3GPP relative power control tests with the TPC setup RPControl. \n
:param pattern: RUA | RDA | RUB | RDB | RUC | RDC RUA | RUB | RUC: ramping up A | B | C RDA | RDB | RDC: ramping down A | B | C
"""
param = Conversions.enum_scalar_to_str(pattern, enums.RpControlPattern)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:RPControl {param}')
[docs]
def get_tpower(self) -> float:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:TPOWer \n
Snippet: value: float = driver.configure.uplink.seta.pusch.tpc.get_tpower() \n
Defines the target powers for power control with the TPC setup FULPower. \n
:return: power: numeric Range: -50 dBm to 33 dBm, Unit: dBm
"""
response = self._core.io.query_str('CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:TPOWer?')
return Conversions.str_to_float(response)
[docs]
def set_tpower(self, power: float) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:TPOWer \n
Snippet: driver.configure.uplink.seta.pusch.tpc.set_tpower(power = 1.0) \n
Defines the target powers for power control with the TPC setup FULPower. \n
:param power: numeric Range: -50 dBm to 33 dBm, Unit: dBm
"""
param = Conversions.decimal_value_to_str(power)
self._core.io.write(f'CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:TPOWer {param}')
# noinspection PyTypeChecker
[docs]
class UdPatternStruct(StructBase): # From WriteStructDefinition CmdPropertyTemplate.xml
"""Structure for setting input parameters. Contains optional set arguments. Fields: \n
- Pattern_Length: int: numeric Number of values to be considered for the pattern Range: 1 to 20
- Value_1: int: numeric Range: -1 dB to 3 dB, Unit: dB
- Value_2: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_3: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_4: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_5: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_6: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_7: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_8: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_9: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_10: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_11: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_12: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_13: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_14: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_15: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_16: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_17: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_18: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_19: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB
- Value_20: int: Optional setting parameter. numeric Range: -1 dB to 3 dB, Unit: dB"""
__meta_args_list = [
ArgStruct.scalar_int('Pattern_Length'),
ArgStruct.scalar_int('Value_1'),
ArgStruct.scalar_int_optional('Value_2'),
ArgStruct.scalar_int_optional('Value_3'),
ArgStruct.scalar_int_optional('Value_4'),
ArgStruct.scalar_int_optional('Value_5'),
ArgStruct.scalar_int_optional('Value_6'),
ArgStruct.scalar_int_optional('Value_7'),
ArgStruct.scalar_int_optional('Value_8'),
ArgStruct.scalar_int_optional('Value_9'),
ArgStruct.scalar_int_optional('Value_10'),
ArgStruct.scalar_int_optional('Value_11'),
ArgStruct.scalar_int_optional('Value_12'),
ArgStruct.scalar_int_optional('Value_13'),
ArgStruct.scalar_int_optional('Value_14'),
ArgStruct.scalar_int_optional('Value_15'),
ArgStruct.scalar_int_optional('Value_16'),
ArgStruct.scalar_int_optional('Value_17'),
ArgStruct.scalar_int_optional('Value_18'),
ArgStruct.scalar_int_optional('Value_19'),
ArgStruct.scalar_int_optional('Value_20')]
def __init__(self):
StructBase.__init__(self, self)
self.Pattern_Length: int = None
self.Value_1: int = None
self.Value_2: int = None
self.Value_3: int = None
self.Value_4: int = None
self.Value_5: int = None
self.Value_6: int = None
self.Value_7: int = None
self.Value_8: int = None
self.Value_9: int = None
self.Value_10: int = None
self.Value_11: int = None
self.Value_12: int = None
self.Value_13: int = None
self.Value_14: int = None
self.Value_15: int = None
self.Value_16: int = None
self.Value_17: int = None
self.Value_18: int = None
self.Value_19: int = None
self.Value_20: int = None
[docs]
def get_ud_pattern(self) -> UdPatternStruct:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:UDPattern \n
Snippet: value: UdPatternStruct = driver.configure.uplink.seta.pusch.tpc.get_ud_pattern() \n
Defines a pattern for power control of the PUSCH with the TPC setup UDSingle or UDContinuous. The pattern consists of 1
to 20 TPC commands. To configure the pattern, specify the pattern length and a corresponding number of TPC commands.
If you specify fewer TPC commands than required according to the pattern length, the previously defined values are used
for the remaining commands. If you specify more TPC commands than required according to the pattern length, all values
are set, but only the values corresponding to the pattern length are used. \n
:return: structure: for return value, see the help for UdPatternStruct structure arguments.
"""
return self._core.io.query_struct('CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:UDPattern?', self.__class__.UdPatternStruct())
[docs]
def set_ud_pattern(self, value: UdPatternStruct) -> None:
"""SCPI: CONFigure:LTE:SIGNaling<instance>:UL:SETA:PUSCh:TPC:UDPattern \n
Snippet with structure: \n
structure = driver.configure.uplink.seta.pusch.tpc.UdPatternStruct() \n
structure.Pattern_Length: int = 1 \n
structure.Value_1: int = 1 \n
structure.Value_2: int = 1 \n
structure.Value_3: int = 1 \n
structure.Value_4: int = 1 \n
structure.Value_5: int = 1 \n
structure.Value_6: int = 1 \n
structure.Value_7: int = 1 \n
structure.Value_8: int = 1 \n
structure.Value_9: int = 1 \n
structure.Value_10: int = 1 \n
structure.Value_11: int = 1 \n
structure.Value_12: int = 1 \n
structure.Value_13: int = 1 \n
structure.Value_14: int = 1 \n
structure.Value_15: int = 1 \n
structure.Value_16: int = 1 \n
structure.Value_17: int = 1 \n
structure.Value_18: int = 1 \n
structure.Value_19: int = 1 \n
structure.Value_20: int = 1 \n
driver.configure.uplink.seta.pusch.tpc.set_ud_pattern(value = structure) \n
Defines a pattern for power control of the PUSCH with the TPC setup UDSingle or UDContinuous. The pattern consists of 1
to 20 TPC commands. To configure the pattern, specify the pattern length and a corresponding number of TPC commands.
If you specify fewer TPC commands than required according to the pattern length, the previously defined values are used
for the remaining commands. If you specify more TPC commands than required according to the pattern length, all values
are set, but only the values corresponding to the pattern length are used. \n
:param value: see the help for UdPatternStruct structure arguments.
"""
self._core.io.write_struct('CONFigure:LTE:SIGNaling<Instance>:UL:SETA:PUSCh:TPC:UDPattern', value)
def clone(self) -> 'TpcCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = TpcCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group