from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class VdbCls:
"""
| Commands in total: 134
| Subgroups: 12
| Direct child commands: 1
Repeated Capability Setting:
.. code-block:: python
# Range: Nr1 .. Nr8 \n
driver.source.bb.gbas.vdb.repcap_vdbTransmitter_set(repcap.VdbTransmitter.Nr1)
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("vdb", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_vdbTransmitter_get', 'repcap_vdbTransmitter_set', repcap.VdbTransmitter.Nr1)
def repcap_vdbTransmitter_set(self, vdbTransmitter: repcap.VdbTransmitter) -> 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 VdbTransmitter.Default.
Default value after init: VdbTransmitter.Nr1
"""
self._cmd_group.set_repcap_enum_value(vdbTransmitter)
def repcap_vdbTransmitter_get(self) -> repcap.VdbTransmitter:
"""
Returns the current default repeated capability for the child set/get methods.
"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def append(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_append'):
from .Append import AppendCls
self._append = AppendCls(self._core, self._cmd_group)
return self._append
@property
def data(self):
"""
| Commands in total: 3
| Subgroups: 2
| Direct child commands: 1
"""
if not hasattr(self, '_data'):
from .Data import DataCls
self._data = DataCls(self._core, self._cmd_group)
return self._data
@property
def dlength(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_dlength'):
from .Dlength import DlengthCls
self._dlength = DlengthCls(self._core, self._cmd_group)
return self._dlength
@property
def fnumber(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_fnumber'):
from .Fnumber import FnumberCls
self._fnumber = FnumberCls(self._core, self._cmd_group)
return self._fnumber
@property
def gid(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_gid'):
from .Gid import GidCls
self._gid = GidCls(self._core, self._cmd_group)
return self._gid
@property
def insert(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_insert'):
from .Insert import InsertCls
self._insert = InsertCls(self._core, self._cmd_group)
return self._insert
@property
def mconfig(self):
"""
| Commands in total: 101
| Subgroups: 54
| Direct child commands: 0
"""
if not hasattr(self, '_mconfig'):
from .Mconfig import MconfigCls
self._mconfig = MconfigCls(self._core, self._cmd_group)
return self._mconfig
@property
def rid(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_rid'):
from .Rid import RidCls
self._rid = RidCls(self._core, self._cmd_group)
return self._rid
@property
def sch(self):
"""
| Commands in total: 20
| Subgroups: 5
| Direct child commands: 0
"""
if not hasattr(self, '_sch'):
from .Sch import SchCls
self._sch = SchCls(self._core, self._cmd_group)
return self._sch
@property
def sgid(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_sgid'):
from .Sgid import SgidCls
self._sgid = SgidCls(self._core, self._cmd_group)
return self._sgid
@property
def ssid(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_ssid'):
from .Ssid import SsidCls
self._ssid = SsidCls(self._core, self._cmd_group)
return self._ssid
@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
[docs]
def delete(self, vdbTransmitter=repcap.VdbTransmitter.Default) -> None:
"""
``[SOURce<HW>]:BB:GBAS:VDB<CH>:DELete`` \n
Snippet: ``driver.source.bb.gbas.vdb.delete(vdbTransmitter = repcap.VdbTransmitter.Default)`` \n
Deletes the selected VDB.
:param vdbTransmitter: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Vdb')
"""
vdbTransmitter_cmd_val = self._cmd_group.get_repcap_cmd_value(vdbTransmitter, repcap.VdbTransmitter)
self._core.io.write(f'SOURce<HwInstance>:BB:GBAS:VDB{vdbTransmitter_cmd_val}:DELete')
[docs]
def delete_with_opc(self, vdbTransmitter=repcap.VdbTransmitter.Default, opc_timeout_ms: int = -1) -> None:
vdbTransmitter_cmd_val = self._cmd_group.get_repcap_cmd_value(vdbTransmitter, repcap.VdbTransmitter)
"""
``[SOURce<HW>]:BB:GBAS:VDB<CH>:DELete`` \n
Snippet: ``driver.source.bb.gbas.vdb.delete_with_opc(vdbTransmitter = repcap.VdbTransmitter.Default)`` \n
Deletes the selected VDB.
Same as delete, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.
:param vdbTransmitter: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Vdb')
: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:GBAS:VDB{vdbTransmitter_cmd_val}:DELete', opc_timeout_ms)
def clone(self) -> 'VdbCls':
"""
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 = VdbCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group