Source code for RsSmbv.Implementations.Source.Bb.Nr5G

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Utilities import trim_str_response
from ..... import enums


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class Nr5GCls: """Nr5G commands group definition. 1456 total commands, 27 Subgroups, 7 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("nr5G", core, parent) @property def analyzer(self): """analyzer commands group. 0 Sub-classes, 2 commands.""" if not hasattr(self, '_analyzer'): from .Analyzer import AnalyzerCls self._analyzer = AnalyzerCls(self._core, self._cmd_group) return self._analyzer @property def cbwx(self): """cbwx commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_cbwx'): from .Cbwx import CbwxCls self._cbwx = CbwxCls(self._core, self._cmd_group) return self._cbwx @property def clock(self): """clock commands group. 0 Sub-classes, 3 commands.""" if not hasattr(self, '_clock'): from .Clock import ClockCls self._clock = ClockCls(self._core, self._cmd_group) return self._clock @property def feature(self): """feature commands group. 1 Sub-classes, 2 commands.""" if not hasattr(self, '_feature'): from .Feature import FeatureCls self._feature = FeatureCls(self._core, self._cmd_group) return self._feature @property def fmode(self): """fmode commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_fmode'): from .Fmode import FmodeCls self._fmode = FmodeCls(self._core, self._cmd_group) return self._fmode @property def hfb(self): """hfb commands group. 1 Sub-classes, 12 commands.""" if not hasattr(self, '_hfb'): from .Hfb import HfbCls self._hfb = HfbCls(self._core, self._cmd_group) return self._hfb @property def k145(self): """k145 commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_k145'): from .K145 import K145Cls self._k145 = K145Cls(self._core, self._cmd_group) return self._k145 @property def k148(self): """k148 commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_k148'): from .K148 import K148Cls self._k148 = K148Cls(self._core, self._cmd_group) return self._k148 @property def k171(self): """k171 commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_k171'): from .K171 import K171Cls self._k171 = K171Cls(self._core, self._cmd_group) return self._k171 @property def k175(self): """k175 commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_k175'): from .K175 import K175Cls self._k175 = K175Cls(self._core, self._cmd_group) return self._k175 @property def k548(self): """k548 commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_k548'): from .K548 import K548Cls self._k548 = K548Cls(self._core, self._cmd_group) return self._k548 @property def k81(self): """k81 commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_k81'): from .K81 import K81Cls self._k81 = K81Cls(self._core, self._cmd_group) return self._k81 @property def logGen(self): """logGen commands group. 0 Sub-classes, 2 commands.""" if not hasattr(self, '_logGen'): from .LogGen import LogGenCls self._logGen = LogGenCls(self._core, self._cmd_group) return self._logGen @property def node(self): """node commands group. 4 Sub-classes, 1 commands.""" if not hasattr(self, '_node'): from .Node import NodeCls self._node = NodeCls(self._core, self._cmd_group) return self._node @property def nsmod(self): """nsmod commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_nsmod'): from .Nsmod import NsmodCls self._nsmod = NsmodCls(self._core, self._cmd_group) return self._nsmod @property def output(self): """output commands group. 6 Sub-classes, 7 commands.""" if not hasattr(self, '_output'): from .Output import OutputCls self._output = OutputCls(self._core, self._cmd_group) return self._output @property def qckset(self): """qckset commands group. 4 Sub-classes, 1 commands.""" if not hasattr(self, '_qckset'): from .Qckset import QcksetCls self._qckset = QcksetCls(self._core, self._cmd_group) return self._qckset @property def sanity(self): """sanity commands group. 0 Sub-classes, 2 commands.""" if not hasattr(self, '_sanity'): from .Sanity import SanityCls self._sanity = SanityCls(self._core, self._cmd_group) return self._sanity @property def scheduling(self): """scheduling commands group. 2 Sub-classes, 3 commands.""" if not hasattr(self, '_scheduling'): from .Scheduling import SchedulingCls self._scheduling = SchedulingCls(self._core, self._cmd_group) return self._scheduling @property def setting(self): """setting commands group. 2 Sub-classes, 4 commands.""" if not hasattr(self, '_setting'): from .Setting import SettingCls self._setting = SettingCls(self._core, self._cmd_group) return self._setting @property def symbolRate(self): """symbolRate commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_symbolRate'): from .SymbolRate import SymbolRateCls self._symbolRate = SymbolRateCls(self._core, self._cmd_group) return self._symbolRate @property def tcw(self): """tcw commands group. 11 Sub-classes, 16 commands.""" if not hasattr(self, '_tcw'): from .Tcw import TcwCls self._tcw = TcwCls(self._core, self._cmd_group) return self._tcw @property def tdWind(self): """tdWind commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_tdWind'): from .TdWind import TdWindCls self._tdWind = TdWindCls(self._core, self._cmd_group) return self._tdWind @property def trigger(self): """trigger commands group. 7 Sub-classes, 5 commands.""" if not hasattr(self, '_trigger'): from .Trigger import TriggerCls self._trigger = TriggerCls(self._core, self._cmd_group) return self._trigger @property def ubwp(self): """ubwp commands group. 2 Sub-classes, 3 commands.""" if not hasattr(self, '_ubwp'): from .Ubwp import UbwpCls self._ubwp = UbwpCls(self._core, self._cmd_group) return self._ubwp @property def uplane(self): """uplane commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_uplane'): from .Uplane import UplaneCls self._uplane = UplaneCls(self._core, self._cmd_group) return self._uplane @property def waveform(self): """waveform commands group. 0 Sub-classes, 1 commands.""" if not hasattr(self, '_waveform'): from .Waveform import WaveformCls self._waveform = WaveformCls(self._core, self._cmd_group) return self._waveform # noinspection PyTypeChecker # noinspection PyTypeChecker
[docs] def get_map_coord(self) -> enums.CoordMapMode: """SCPI: [SOURce<HW>]:BB:NR5G:MAPCoord \n Snippet: value: enums.CoordMapMode = driver.source.bb.nr5G.get_map_coord() \n No command help available \n :return: coord_map_mode: No help available """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:MAPCoord?') return Conversions.str_to_scalar_enum(response, enums.CoordMapMode)
[docs] def set_map_coord(self, coord_map_mode: enums.CoordMapMode) -> None: """SCPI: [SOURce<HW>]:BB:NR5G:MAPCoord \n Snippet: driver.source.bb.nr5G.set_map_coord(coord_map_mode = enums.CoordMapMode.CARTesian) \n No command help available \n :param coord_map_mode: No help available """ param = Conversions.enum_scalar_to_str(coord_map_mode, enums.CoordMapMode) self._core.io.write(f'SOURce<HwInstance>:BB:NR5G:MAPCoord {param}')
[docs] def get_pl_version(self) -> str: """SCPI: [SOURce]:BB:NR5G:PLVersion \n Snippet: value: str = driver.source.bb.nr5G.get_pl_version() \n Queries the installed version of the 5G New Radio application. \n :return: plugin_version: string """ response = self._core.io.query_str('SOURce:BB:NR5G:PLVersion?') return trim_str_response(response)
[docs] def preset(self) -> None: """SCPI: [SOURce<HW>]:BB:NR5G:PRESet \n Snippet: driver.source.bb.nr5G.preset() \n Sets the parameters of the digital standard to their default values (*RST values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:NR5G:STATe. \n """ self._core.io.write(f'SOURce<HwInstance>:BB:NR5G:PRESet')
[docs] def preset_with_opc(self, opc_timeout_ms: int = -1) -> None: """SCPI: [SOURce<HW>]:BB:NR5G:PRESet \n Snippet: driver.source.bb.nr5G.preset_with_opc() \n Sets the parameters of the digital standard to their default values (*RST values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:NR5G:STATe. \n Same as preset, but waits for the operation to complete before continuing further. Use the RsSmbv.utilities.opc_timeout_set() to set the timeout value. \n :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.""" self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:NR5G:PRESet', opc_timeout_ms)
[docs] def get_simple(self) -> bool: """SCPI: [SOURce<HW>]:BB:NR5G:SIMPle \n Snippet: value: bool = driver.source.bb.nr5G.get_simple() \n Turns the simple mode of the user interface on and off. \n :return: state: 1| ON| 0| OFF """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:SIMPle?') return Conversions.str_to_bool(response)
[docs] def set_simple(self, state: bool) -> None: """SCPI: [SOURce<HW>]:BB:NR5G:SIMPle \n Snippet: driver.source.bb.nr5G.set_simple(state = False) \n Turns the simple mode of the user interface on and off. \n :param state: 1| ON| 0| OFF """ param = Conversions.bool_to_str(state) self._core.io.write(f'SOURce<HwInstance>:BB:NR5G:SIMPle {param}')
[docs] def get_state(self) -> bool: """SCPI: [SOURce<HW>]:BB:NR5G:STATe \n Snippet: value: bool = driver.source.bb.nr5G.get_state() \n Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n :return: state: 1| ON| 0| OFF """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:STATe?') return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None: """SCPI: [SOURce<HW>]:BB:NR5G:STATe \n Snippet: driver.source.bb.nr5G.set_state(state = False) \n Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n :param state: 1| ON| 0| OFF """ param = Conversions.bool_to_str(state) self._core.io.write(f'SOURce<HwInstance>:BB:NR5G:STATe {param}')
[docs] def get_version(self) -> str: """SCPI: [SOURce]:BB:NR5G:VERSion \n Snippet: value: str = driver.source.bb.nr5G.get_version() \n Queries the version of the 3GPP standard underlying the definitions. \n :return: version: string """ response = self._core.io.query_str('SOURce:BB:NR5G:VERSion?') return trim_str_response(response)
def clone(self) -> 'Nr5GCls': """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 = Nr5GCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group