from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class MstationCls:
"""
| Commands in total: 27
| Subgroups: 8
| Direct child commands: 1
Repeated Capability Setting:
.. code-block:: python
# Range: Nr1 .. Nr4 \n
driver.source.bb.c2K.mstation.repcap_mobileStation_set(repcap.MobileStation.Nr1)
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("mstation", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_mobileStation_get', 'repcap_mobileStation_set', repcap.MobileStation.Nr1)
def repcap_mobileStation_set(self, mobileStation: repcap.MobileStation) -> None:
"""
Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to MobileStation.Default.
Default value after init: MobileStation.Nr1
"""
self._cmd_group.set_repcap_enum_value(mobileStation)
def repcap_mobileStation_get(self) -> repcap.MobileStation:
"""
Returns the current default repeated capability for the child set/get methods.
"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def additional(self):
"""
| Commands in total: 5
| Subgroups: 3
| Direct child commands: 2
"""
if not hasattr(self, '_additional'):
from .Additional import AdditionalCls
self._additional = AdditionalCls(self._core, self._cmd_group)
return self._additional
@property
def ccoding(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_ccoding'):
from .Ccoding import CcodingCls
self._ccoding = CcodingCls(self._core, self._cmd_group)
return self._ccoding
@property
def channel(self):
"""
| Commands in total: 10
| Subgroups: 7
| Direct child commands: 0
"""
if not hasattr(self, '_channel'):
from .Channel import ChannelCls
self._channel = ChannelCls(self._core, self._cmd_group)
return self._channel
@property
def lcMask(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_lcMask'):
from .LcMask import LcMaskCls
self._lcMask = LcMaskCls(self._core, self._cmd_group)
return self._lcMask
@property
def mode(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_mode'):
from .Mode import ModeCls
self._mode = ModeCls(self._core, self._cmd_group)
return self._mode
@property
def rconfiguration(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_rconfiguration'):
from .Rconfiguration import RconfigurationCls
self._rconfiguration = RconfigurationCls(self._core, self._cmd_group)
return self._rconfiguration
@property
def state(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_state'):
from .State import StateCls
self._state = StateCls(self._core, self._cmd_group)
return self._state
@property
def tpc(self):
"""
| Commands in total: 6
| Subgroups: 4
| Direct child commands: 0
"""
if not hasattr(self, '_tpc'):
from .Tpc import TpcCls
self._tpc = TpcCls(self._core, self._cmd_group)
return self._tpc
[docs]
def preset(self) -> None:
"""
``[SOURce<HW>]:BB:C2K:MSTation:PRESet`` \n
Snippet: ``driver.source.bb.c2K.mstation.preset()`` \n
A standardized default for all the mobile stations (``*RST`` values specified for the commands) . See 'Reset All Mobile
Stations' for an overview.
"""
self._core.io.write(f'SOURce<HwInstance>:BB:C2K:MSTation:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``[SOURce<HW>]:BB:C2K:MSTation:PRESet`` \n
Snippet: ``driver.source.bb.c2K.mstation.preset_with_opc()`` \n
A standardized default for all the mobile stations (``*RST`` values specified for the commands) . See 'Reset All Mobile
Stations' for an overview.
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:C2K:MSTation:PRESet', opc_timeout_ms)
def clone(self) -> 'MstationCls':
"""
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 = MstationCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group