from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class DownlinkCls:
"""Downlink commands group definition. 619 total commands, 25 Subgroups, 14 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("downlink", core, parent)
@property
def ca(self):
"""ca commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_ca'):
from .Ca import CaCls
self._ca = CaCls(self._core, self._cmd_group)
return self._ca
@property
def carrier(self):
"""carrier commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_carrier'):
from .Carrier import CarrierCls
self._carrier = CarrierCls(self._core, self._cmd_group)
return self._carrier
@property
def conf(self):
"""conf commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_conf'):
from .Conf import ConfCls
self._conf = ConfCls(self._core, self._cmd_group)
return self._conf
@property
def csettings(self):
"""csettings commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_csettings'):
from .Csettings import CsettingsCls
self._csettings = CsettingsCls(self._core, self._cmd_group)
return self._csettings
@property
def csis(self):
"""csis commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_csis'):
from .Csis import CsisCls
self._csis = CsisCls(self._core, self._cmd_group)
return self._csis
@property
def drs(self):
"""drs commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_drs'):
from .Drs import DrsCls
self._drs = DrsCls(self._core, self._cmd_group)
return self._drs
@property
def dumd(self):
"""dumd commands group. 1 Sub-classes, 5 commands."""
if not hasattr(self, '_dumd'):
from .Dumd import DumdCls
self._dumd = DumdCls(self._core, self._cmd_group)
return self._dumd
@property
def emtc(self):
"""emtc commands group. 5 Sub-classes, 4 commands."""
if not hasattr(self, '_emtc'):
from .Emtc import EmtcCls
self._emtc = EmtcCls(self._core, self._cmd_group)
return self._emtc
@property
def laa(self):
"""laa commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_laa'):
from .Laa import LaaCls
self._laa = LaaCls(self._core, self._cmd_group)
return self._laa
@property
def mbsfn(self):
"""mbsfn commands group. 4 Sub-classes, 3 commands."""
if not hasattr(self, '_mbsfn'):
from .Mbsfn import MbsfnCls
self._mbsfn = MbsfnCls(self._core, self._cmd_group)
return self._mbsfn
@property
def mimo(self):
"""mimo commands group. 2 Sub-classes, 2 commands."""
if not hasattr(self, '_mimo'):
from .Mimo import MimoCls
self._mimo = MimoCls(self._core, self._cmd_group)
return self._mimo
@property
def niot(self):
"""niot commands group. 9 Sub-classes, 3 commands."""
if not hasattr(self, '_niot'):
from .Niot import NiotCls
self._niot = NiotCls(self._core, self._cmd_group)
return self._niot
@property
def pbch(self):
"""pbch commands group. 0 Sub-classes, 4 commands."""
if not hasattr(self, '_pbch'):
from .Pbch import PbchCls
self._pbch = PbchCls(self._core, self._cmd_group)
return self._pbch
@property
def pdcch(self):
"""pdcch commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_pdcch'):
from .Pdcch import PdcchCls
self._pdcch = PdcchCls(self._core, self._cmd_group)
return self._pdcch
@property
def pdsch(self):
"""pdsch commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_pdsch'):
from .Pdsch import PdschCls
self._pdsch = PdschCls(self._core, self._cmd_group)
return self._pdsch
@property
def phich(self):
"""phich commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_phich'):
from .Phich import PhichCls
self._phich = PhichCls(self._core, self._cmd_group)
return self._phich
@property
def prss(self):
"""prss commands group. 2 Sub-classes, 6 commands."""
if not hasattr(self, '_prss'):
from .Prss import PrssCls
self._prss = PrssCls(self._core, self._cmd_group)
return self._prss
@property
def refsig(self):
"""refsig commands group. 1 Sub-classes, 6 commands."""
if not hasattr(self, '_refsig'):
from .Refsig import RefsigCls
self._refsig = RefsigCls(self._core, self._cmd_group)
return self._refsig
@property
def rstFrame(self):
"""rstFrame commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_rstFrame'):
from .RstFrame import RstFrameCls
self._rstFrame = RstFrameCls(self._core, self._cmd_group)
return self._rstFrame
@property
def sync(self):
"""sync commands group. 1 Sub-classes, 7 commands."""
if not hasattr(self, '_sync'):
from .Sync import SyncCls
self._sync = SyncCls(self._core, self._cmd_group)
return self._sync
@property
def user(self):
"""user commands group. 26 Sub-classes, 0 commands."""
if not hasattr(self, '_user'):
from .User import UserCls
self._user = UserCls(self._core, self._cmd_group)
return self._user
@property
def view(self):
"""view commands group. 0 Sub-classes, 5 commands."""
if not hasattr(self, '_view'):
from .View import ViewCls
self._view = ViewCls(self._core, self._cmd_group)
return self._view
@property
def cell(self):
"""cell commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_cell'):
from .Cell import CellCls
self._cell = CellCls(self._core, self._cmd_group)
return self._cell
@property
def plci(self):
"""plci commands group. 0 Sub-classes, 3 commands."""
if not hasattr(self, '_plci'):
from .Plci import PlciCls
self._plci = PlciCls(self._core, self._cmd_group)
return self._plci
@property
def subf(self):
"""subf commands group. 5 Sub-classes, 0 commands."""
if not hasattr(self, '_subf'):
from .Subf import SubfCls
self._subf = SubfCls(self._core, self._cmd_group)
return self._subf
# noinspection PyTypeChecker
[docs] def get_bur(self) -> enums.EutraBehUnsSubFrames:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:BUR \n
Snippet: value: enums.EutraBehUnsSubFrames = driver.source.bb.eutra.downlink.get_bur() \n
Selects either to fill unscheduled resource elements and subframes with dummy data or DTX. In 'Mode > eMTC/NB-IoT',
unused resource elements are filled in with DTX. \n
:return: bur: DUData| DTX
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:BUR?')
return Conversions.str_to_scalar_enum(response, enums.EutraBehUnsSubFrames)
[docs] def set_bur(self, bur: enums.EutraBehUnsSubFrames) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:BUR \n
Snippet: driver.source.bb.eutra.downlink.set_bur(bur = enums.EutraBehUnsSubFrames.DTX) \n
Selects either to fill unscheduled resource elements and subframes with dummy data or DTX. In 'Mode > eMTC/NB-IoT',
unused resource elements are filled in with DTX. \n
:param bur: DUData| DTX
"""
param = Conversions.enum_scalar_to_str(bur, enums.EutraBehUnsSubFrames)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:BUR {param}')
# noinspection PyTypeChecker
[docs] def get_bw(self) -> enums.EutraChannelBandwidth:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:BW \n
Snippet: value: enums.EutraChannelBandwidth = driver.source.bb.eutra.downlink.get_bw() \n
Sets the DL channel bandwidth. \n
:return: bw: BW1_40| BW3_00| BW5_00| BW10_00| BW15_00| BW20_00 | BW0_20 | USER
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:BW?')
return Conversions.str_to_scalar_enum(response, enums.EutraChannelBandwidth)
[docs] def set_bw(self, bw: enums.EutraChannelBandwidth) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:BW \n
Snippet: driver.source.bb.eutra.downlink.set_bw(bw = enums.EutraChannelBandwidth.BW0_20) \n
Sets the DL channel bandwidth. \n
:param bw: BW1_40| BW3_00| BW5_00| BW10_00| BW15_00| BW20_00 | BW0_20 | USER
"""
param = Conversions.enum_scalar_to_str(bw, enums.EutraChannelBandwidth)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:BW {param}')
[docs] def get_con_sub_frames(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:CONSubframes \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_con_sub_frames() \n
Sets the number of configurable subframes. \n
:return: con_sub_frames: integer Range: 1 to 40
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:CONSubframes?')
return Conversions.str_to_int(response)
[docs] def set_con_sub_frames(self, con_sub_frames: int) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:CONSubframes \n
Snippet: driver.source.bb.eutra.downlink.set_con_sub_frames(con_sub_frames = 1) \n
Sets the number of configurable subframes. \n
:param con_sub_frames: integer Range: 1 to 40
"""
param = Conversions.decimal_value_to_str(con_sub_frames)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:CONSubframes {param}')
# noinspection PyTypeChecker
[docs] def get_cpc(self) -> enums.EutraCyclicPrefixGs:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:CPC \n
Snippet: value: enums.EutraCyclicPrefixGs = driver.source.bb.eutra.downlink.get_cpc() \n
Sets the cyclic prefix length for all LTE subframes. \n
:return: cyclic_prefix: NORMal| EXTended | USER
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:CPC?')
return Conversions.str_to_scalar_enum(response, enums.EutraCyclicPrefixGs)
[docs] def set_cpc(self, cyclic_prefix: enums.EutraCyclicPrefixGs) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:CPC \n
Snippet: driver.source.bb.eutra.downlink.set_cpc(cyclic_prefix = enums.EutraCyclicPrefixGs.EXTended) \n
Sets the cyclic prefix length for all LTE subframes. \n
:param cyclic_prefix: NORMal| EXTended | USER
"""
param = Conversions.enum_scalar_to_str(cyclic_prefix, enums.EutraCyclicPrefixGs)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:CPC {param}')
[docs] def get_fft(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:FFT \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_fft() \n
Sets the FFT size. \n
:return: fft: integer Range: 64 to 2048
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:FFT?')
return Conversions.str_to_int(response)
[docs] def set_fft(self, fft: int) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:FFT \n
Snippet: driver.source.bb.eutra.downlink.set_fft(fft = 1) \n
Sets the FFT size. \n
:param fft: integer Range: 64 to 2048
"""
param = Conversions.decimal_value_to_str(fft)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:FFT {param}')
[docs] def get_lgs(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:LGS \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_lgs() \n
Queries the number of left guard subcarriers. \n
:return: lgs: integer Range: 28 to 364
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:LGS?')
return Conversions.str_to_int(response)
[docs] def get_no_rb(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:NORB \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_no_rb() \n
Selects the number of physical resource blocks per slot. \n
:return: no_rb: integer Range: 6 to 110
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:NORB?')
return Conversions.str_to_int(response)
[docs] def set_no_rb(self, no_rb: int) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:NORB \n
Snippet: driver.source.bb.eutra.downlink.set_no_rb(no_rb = 1) \n
Selects the number of physical resource blocks per slot. \n
:param no_rb: integer Range: 6 to 110
"""
param = Conversions.decimal_value_to_str(no_rb)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:NORB {param}')
[docs] def get_occ_bandwidth(self) -> float:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:OCCBandwidth \n
Snippet: value: float = driver.source.bb.eutra.downlink.get_occ_bandwidth() \n
Queries the occupied bandwidth. \n
:return: occup_bandwidth: float
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:OCCBandwidth?')
return Conversions.str_to_float(response)
[docs] def get_occ_subcarriers(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:OCCSubcarriers \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_occ_subcarriers() \n
Queries the occupied subcarriers. \n
:return: occup_subcarr: integer Range: 72 to 1321
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:OCCSubcarriers?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs] def get_pum(self) -> enums.EutraPwrUpdMode:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:PUM \n
Snippet: value: enums.EutraPwrUpdMode = driver.source.bb.eutra.downlink.get_pum() \n
No command help available \n
:return: power_update_mode: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:PUM?')
return Conversions.str_to_scalar_enum(response, enums.EutraPwrUpdMode)
[docs] def set_pum(self, power_update_mode: enums.EutraPwrUpdMode) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:PUM \n
Snippet: driver.source.bb.eutra.downlink.set_pum(power_update_mode = enums.EutraPwrUpdMode.CONTinuous) \n
No command help available \n
:param power_update_mode: No help available
"""
param = Conversions.enum_scalar_to_str(power_update_mode, enums.EutraPwrUpdMode)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:PUM {param}')
[docs] def get_rgs(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:RGS \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_rgs() \n
Queries the number of right guard subcarriers. \n
:return: rgs: integer Range: 27 to 364
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:RGS?')
return Conversions.str_to_int(response)
[docs] def get_sf_selection(self) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:SFSelection \n
Snippet: value: int = driver.source.bb.eutra.downlink.get_sf_selection() \n
No command help available \n
:return: sub_frame_sel: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:SFSelection?')
return Conversions.str_to_int(response)
[docs] def set_sf_selection(self, sub_frame_sel: int) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:SFSelection \n
Snippet: driver.source.bb.eutra.downlink.set_sf_selection(sub_frame_sel = 1) \n
No command help available \n
:param sub_frame_sel: No help available
"""
param = Conversions.decimal_value_to_str(sub_frame_sel)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:SFSelection {param}')
[docs] def get_symbol_rate(self) -> float:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:SRATe \n
Snippet: value: float = driver.source.bb.eutra.downlink.get_symbol_rate() \n
Queries the sampling rate. \n
:return: sample_rate: float Range: 192E4 to 3072E4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:SRATe?')
return Conversions.str_to_float(response)
# noinspection PyTypeChecker
[docs] def get_ulcpc(self) -> enums.EuTraDuration:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:ULCPc \n
Snippet: value: enums.EuTraDuration = driver.source.bb.eutra.downlink.get_ulcpc() \n
In TDD duplexing mode, sets the cyclic prefix for the opposite direction. \n
:return: gs_cpc_opp_dir: NORMal| EXTended
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:ULCPc?')
return Conversions.str_to_scalar_enum(response, enums.EuTraDuration)
[docs] def set_ulcpc(self, gs_cpc_opp_dir: enums.EuTraDuration) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:ULCPc \n
Snippet: driver.source.bb.eutra.downlink.set_ulcpc(gs_cpc_opp_dir = enums.EuTraDuration.EXTended) \n
In TDD duplexing mode, sets the cyclic prefix for the opposite direction. \n
:param gs_cpc_opp_dir: NORMal| EXTended
"""
param = Conversions.enum_scalar_to_str(gs_cpc_opp_dir, enums.EuTraDuration)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:ULCPc {param}')
def clone(self) -> 'DownlinkCls':
"""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 = DownlinkCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group