from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class OnewebCls:
"""
| Commands in total: 408
| Subgroups: 14
| Direct child commands: 6
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("oneweb", core, parent)
@property
def clipping(self):
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
if not hasattr(self, '_clipping'):
from .Clipping import ClippingCls
self._clipping = ClippingCls(self._core, self._cmd_group)
return self._clipping
@property
def clock(self):
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
if not hasattr(self, '_clock'):
from .Clock import ClockCls
self._clock = ClockCls(self._core, self._cmd_group)
return self._clock
@property
def downlink(self):
"""
| Commands in total: 154
| Subgroups: 13
| Direct child commands: 12
"""
if not hasattr(self, '_downlink'):
from .Downlink import DownlinkCls
self._downlink = DownlinkCls(self._core, self._cmd_group)
return self._downlink
@property
def filterPy(self):
"""
| Commands in total: 17
| Subgroups: 1
| Direct child commands: 3
"""
if not hasattr(self, '_filterPy'):
from .FilterPy import FilterPyCls
self._filterPy = FilterPyCls(self._core, self._cmd_group)
return self._filterPy
@property
def notch(self):
"""
| Commands in total: 8
| Subgroups: 4
| Direct child commands: 3
"""
if not hasattr(self, '_notch'):
from .Notch import NotchCls
self._notch = NotchCls(self._core, self._cmd_group)
return self._notch
@property
def powc(self):
"""
| Commands in total: 4
| Subgroups: 0
| Direct child commands: 4
"""
if not hasattr(self, '_powc'):
from .Powc import PowcCls
self._powc = PowcCls(self._core, self._cmd_group)
return self._powc
@property
def refSignal(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_refSignal'):
from .RefSignal import RefSignalCls
self._refSignal = RefSignalCls(self._core, self._cmd_group)
return self._refSignal
@property
def setting(self):
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
if not hasattr(self, '_setting'):
from .Setting import SettingCls
self._setting = SettingCls(self._core, self._cmd_group)
return self._setting
@property
def symbolRate(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_symbolRate'):
from .SymbolRate import SymbolRateCls
self._symbolRate = SymbolRateCls(self._core, self._cmd_group)
return self._symbolRate
@property
def tdw(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_tdw'):
from .Tdw import TdwCls
self._tdw = TdwCls(self._core, self._cmd_group)
return self._tdw
@property
def trigger(self):
"""
| Commands in total: 30
| Subgroups: 7
| Direct child commands: 5
"""
if not hasattr(self, '_trigger'):
from .Trigger import TriggerCls
self._trigger = TriggerCls(self._core, self._cmd_group)
return self._trigger
@property
def udt(self):
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
if not hasattr(self, '_udt'):
from .Udt import UdtCls
self._udt = UdtCls(self._core, self._cmd_group)
return self._udt
@property
def uplink(self):
"""
| Commands in total: 171
| Subgroups: 11
| Direct child commands: 12
"""
if not hasattr(self, '_uplink'):
from .Uplink import UplinkCls
self._uplink = UplinkCls(self._core, self._cmd_group)
return self._uplink
@property
def waveform(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
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_cmod(self) -> enums.OneWebConfMode:
"""
``[SOURce<HW>]:BB:ONEWeb:CMOD`` \n
Snippet: ``value: enums.OneWebConfMode = driver.source.bb.oneweb.get_cmod()`` \n
Sets the configuration mode.
:return: config_mode: PREDefined | USER
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:CMOD?')
return Conversions.str_to_scalar_enum(response, enums.OneWebConfMode)
[docs]
def set_cmod(self, config_mode: enums.OneWebConfMode) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:CMOD`` \n
Snippet: ``driver.source.bb.oneweb.set_cmod(config_mode = enums.OneWebConfMode.PREDefined)`` \n
Sets the configuration mode.
:param config_mode: PREDefined | USER
"""
param = Conversions.enum_scalar_to_str(config_mode, enums.OneWebConfMode)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:CMOD {param}')
# noinspection PyTypeChecker
[docs]
def get_duplexing(self) -> enums.OneWebDuplexModeRange:
"""
``[SOURce<HW>]:BB:ONEWeb:DUPLexing`` \n
Snippet: ``value: enums.OneWebDuplexModeRange = driver.source.bb.oneweb.get_duplexing()`` \n
Queries the duplexing mode.
:return: duplexing: FDD
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:DUPLexing?')
return Conversions.str_to_scalar_enum(response, enums.OneWebDuplexModeRange)
# noinspection PyTypeChecker
[docs]
def get_link(self) -> enums.UpDownDirection:
"""
``[SOURce<HW>]:BB:ONEWeb:LINK`` \n
Snippet: ``value: enums.UpDownDirection = driver.source.bb.oneweb.get_link()`` \n
Sets the transmission direction.
:return: link: UP | DOWN
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:LINK?')
return Conversions.str_to_scalar_enum(response, enums.UpDownDirection)
[docs]
def set_link(self, link: enums.UpDownDirection) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:LINK`` \n
Snippet: ``driver.source.bb.oneweb.set_link(link = enums.UpDownDirection.DOWN)`` \n
Sets the transmission direction.
:param link: UP | DOWN
"""
param = Conversions.enum_scalar_to_str(link, enums.UpDownDirection)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:LINK {param}')
[docs]
def preset(self) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:PRESet`` \n
Snippet: ``driver.source.bb.oneweb.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:ONEWeb:STATe.
"""
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:PRESet`` \n
Snippet: ``driver.source.bb.oneweb.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:ONEWeb:STATe.
Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.
: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:ONEWeb:PRESet', opc_timeout_ms)
[docs]
def get_slength(self) -> int:
"""
``[SOURce<HW>]:BB:ONEWeb:SLENgth`` \n
Snippet: ``value: int = driver.source.bb.oneweb.get_slength()`` \n
Sets the sequence length of the signal in number of frames. The signal is calculated in advance and output in the
arbitrary waveform generator. The maximum number of frames is calculated as follows: Max. No. of Frames = Arbitrary
waveform memory size/(sampling rate x 10 ms) .
:return: slength: integer Range: 1 to dynamic
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:SLENgth?')
return Conversions.str_to_int(response)
[docs]
def set_slength(self, slength: int) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:SLENgth`` \n
Snippet: ``driver.source.bb.oneweb.set_slength(slength = 1)`` \n
Sets the sequence length of the signal in number of frames. The signal is calculated in advance and output in the
arbitrary waveform generator. The maximum number of frames is calculated as follows: Max. No. of Frames = Arbitrary
waveform memory size/(sampling rate x 10 ms) .
:param slength: integer Range: 1 to dynamic
"""
param = Conversions.decimal_value_to_str(slength)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:SLENgth {param}')
[docs]
def get_state(self) -> bool:
"""
``[SOURce<HW>]:BB:ONEWeb:STATe`` \n
Snippet: ``value: bool = driver.source.bb.oneweb.get_state()`` \n
Activates the standard.
:return: one_web_state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, one_web_state: bool) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:STATe`` \n
Snippet: ``driver.source.bb.oneweb.set_state(one_web_state = False)`` \n
Activates the standard.
:param one_web_state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(one_web_state)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:STATe {param}')
def clone(self) -> 'OnewebCls':
"""
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 = OnewebCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group