from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class BstationCls:
"""
| Commands in total: 57
| Subgroups: 9
| Direct child commands: 1
Repeated Capability Setting:
.. code-block:: python
# Range: Nr1 .. Nr4 \n
driver.source.bb.c2K.bstation.repcap_baseStation_set(repcap.BaseStation.Nr1)
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("bstation", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_baseStation_get', 'repcap_baseStation_set', repcap.BaseStation.Nr1)
def repcap_baseStation_set(self, baseStation: repcap.BaseStation) -> 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 BaseStation.Default.
Default value after init: BaseStation.Nr1
"""
self._cmd_group.set_repcap_enum_value(baseStation)
def repcap_baseStation_get(self) -> repcap.BaseStation:
"""
Returns the current default repeated capability for the child set/get methods.
"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def cgroup(self):
"""
| Commands in total: 32
| Subgroups: 2
| Direct child commands: 0
"""
if not hasattr(self, '_cgroup'):
from .Cgroup import CgroupCls
self._cgroup = CgroupCls(self._core, self._cmd_group)
return self._cgroup
@property
def dconflict(self):
"""
| Commands in total: 3
| Subgroups: 3
| Direct child commands: 0
"""
if not hasattr(self, '_dconflict'):
from .Dconflict import DconflictCls
self._dconflict = DconflictCls(self._core, self._cmd_group)
return self._dconflict
@property
def pdChannel(self):
"""
| Commands in total: 8
| Subgroups: 4
| Direct child commands: 0
"""
if not hasattr(self, '_pdChannel'):
from .PdChannel import PdChannelCls
self._pdChannel = PdChannelCls(self._core, self._cmd_group)
return self._pdChannel
@property
def pnOffset(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_pnOffset'):
from .PnOffset import PnOffsetCls
self._pnOffset = PnOffsetCls(self._core, self._cmd_group)
return self._pnOffset
@property
def qwSet(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_qwSet'):
from .QwSet import QwSetCls
self._qwSet = QwSetCls(self._core, self._cmd_group)
return self._qwSet
@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 sync(self):
"""
| Commands in total: 7
| Subgroups: 0
| Direct child commands: 7
"""
if not hasattr(self, '_sync'):
from .Sync import SyncCls
self._sync = SyncCls(self._core, self._cmd_group)
return self._sync
@property
def tdelay(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_tdelay'):
from .Tdelay import TdelayCls
self._tdelay = TdelayCls(self._core, self._cmd_group)
return self._tdelay
@property
def tdiversity(self):
"""
| Commands in total: 2
| Subgroups: 1
| Direct child commands: 1
"""
if not hasattr(self, '_tdiversity'):
from .Tdiversity import TdiversityCls
self._tdiversity = TdiversityCls(self._core, self._cmd_group)
return self._tdiversity
[docs]
def preset(self) -> None:
"""
``[SOURce<HW>]:BB:C2K:BSTation:PRESet`` \n
Snippet: ``driver.source.bb.c2K.bstation.preset()`` \n
A standardized default for all the base stations (``*RST`` values specified for the commands) . See 'Reset All Base
Stations' for an overview.
"""
self._core.io.write(f'SOURce<HwInstance>:BB:C2K:BSTation:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``[SOURce<HW>]:BB:C2K:BSTation:PRESet`` \n
Snippet: ``driver.source.bb.c2K.bstation.preset_with_opc()`` \n
A standardized default for all the base stations (``*RST`` values specified for the commands) . See 'Reset All Base
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:BSTation:PRESet', opc_timeout_ms)
def clone(self) -> 'BstationCls':
"""
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 = BstationCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group