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 C2KCls:
"""C2K commands group definition. 146 total commands, 13 Subgroups, 5 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("c2K", core, parent)
@property
def bstation(self):
"""bstation commands group. 9 Sub-classes, 1 commands."""
if not hasattr(self, '_bstation'):
from .Bstation import BstationCls
self._bstation = BstationCls(self._core, self._cmd_group)
return self._bstation
@property
def clipping(self):
"""clipping commands group. 0 Sub-classes, 3 commands."""
if not hasattr(self, '_clipping'):
from .Clipping import ClippingCls
self._clipping = ClippingCls(self._core, self._cmd_group)
return self._clipping
@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 copy(self):
"""copy commands group. 1 Sub-classes, 3 commands."""
if not hasattr(self, '_copy'):
from .Copy import CopyCls
self._copy = CopyCls(self._core, self._cmd_group)
return self._copy
@property
def crate(self):
"""crate commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_crate'):
from .Crate import CrateCls
self._crate = CrateCls(self._core, self._cmd_group)
return self._crate
@property
def filterPy(self):
"""filterPy commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_filterPy'):
from .FilterPy import FilterPyCls
self._filterPy = FilterPyCls(self._core, self._cmd_group)
return self._filterPy
@property
def iqswap(self):
"""iqswap commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_iqswap'):
from .Iqswap import IqswapCls
self._iqswap = IqswapCls(self._core, self._cmd_group)
return self._iqswap
@property
def mstation(self):
"""mstation commands group. 8 Sub-classes, 1 commands."""
if not hasattr(self, '_mstation'):
from .Mstation import MstationCls
self._mstation = MstationCls(self._core, self._cmd_group)
return self._mstation
@property
def power(self):
"""power commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_power'):
from .Power import PowerCls
self._power = PowerCls(self._core, self._cmd_group)
return self._power
@property
def pparameter(self):
"""pparameter commands group. 5 Sub-classes, 2 commands."""
if not hasattr(self, '_pparameter'):
from .Pparameter import PparameterCls
self._pparameter = PparameterCls(self._core, self._cmd_group)
return self._pparameter
@property
def setting(self):
"""setting commands group. 0 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 trigger(self):
"""trigger commands group. 5 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 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
[docs] def get_link(self) -> enums.LinkDir:
"""SCPI: [SOURce<HW>]:BB:C2K:LINK \n
Snippet: value: enums.LinkDir = driver.source.bb.c2K.get_link() \n
The command defines the transmission direction. The signal either corresponds to that of a base station (FORWard | DOWN)
or that of a mobile station (REVerse | UP) . \n
:return: link: DOWN| UP| FORWard| REVerse
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:C2K:LINK?')
return Conversions.str_to_scalar_enum(response, enums.LinkDir)
[docs] def set_link(self, link: enums.LinkDir) -> None:
"""SCPI: [SOURce<HW>]:BB:C2K:LINK \n
Snippet: driver.source.bb.c2K.set_link(link = enums.LinkDir.DOWN) \n
The command defines the transmission direction. The signal either corresponds to that of a base station (FORWard | DOWN)
or that of a mobile station (REVerse | UP) . \n
:param link: DOWN| UP| FORWard| REVerse
"""
param = Conversions.enum_scalar_to_str(link, enums.LinkDir)
self._core.io.write(f'SOURce<HwInstance>:BB:C2K:LINK {param}')
[docs] def preset(self) -> None:
"""SCPI: [SOURce<HW>]:BB:C2K:PRESet \n
Snippet: driver.source.bb.c2K.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:C2K:STATe. \n
"""
self._core.io.write(f'SOURce<HwInstance>:BB:C2K:PRESet')
[docs] def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: [SOURce<HW>]:BB:C2K:PRESet \n
Snippet: driver.source.bb.c2K.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:C2K: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:C2K:PRESet', opc_timeout_ms)
[docs] def get_slength(self) -> int:
"""SCPI: [SOURce<HW>]:BB:C2K:SLENgth \n
Snippet: value: int = driver.source.bb.c2K.get_slength() \n
Sets the sequence length of the arbitrary waveform component of the CDMA2000 signal in the number of frames. \n
:return: slength: integer Range: 1 to max
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:C2K:SLENgth?')
return Conversions.str_to_int(response)
[docs] def set_slength(self, slength: int) -> None:
"""SCPI: [SOURce<HW>]:BB:C2K:SLENgth \n
Snippet: driver.source.bb.c2K.set_slength(slength = 1) \n
Sets the sequence length of the arbitrary waveform component of the CDMA2000 signal in the number of frames. \n
:param slength: integer Range: 1 to max
"""
param = Conversions.decimal_value_to_str(slength)
self._core.io.write(f'SOURce<HwInstance>:BB:C2K:SLENgth {param}')
[docs] def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:C2K:STATe \n
Snippet: value: bool = driver.source.bb.c2K.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:C2K:STATe?')
return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:C2K:STATe \n
Snippet: driver.source.bb.c2K.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:C2K:STATe {param}')
[docs] def get_version(self) -> str:
"""SCPI: [SOURce]:BB:C2K:VERSion \n
Snippet: value: str = driver.source.bb.c2K.get_version() \n
The command queries the version of the CDMA standard underlying the definitions. \n
:return: version: string
"""
response = self._core.io.query_str('SOURce:BB:C2K:VERSion?')
return trim_str_response(response)
def clone(self) -> 'C2KCls':
"""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 = C2KCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group