from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal.RepeatedCapability import RepeatedCapability
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DeembeddingCls:
"""
| Commands in total: 38
| Subgroups: 10
| Direct child commands: 4
Repeated Capability Setting:
.. code-block:: python
# Range: Nr1 .. Nr4 \n
driver.deembedding.repcap_deembedding_set(repcap.Deembedding.Nr1)
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("deembedding", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_deembedding_get', 'repcap_deembedding_set', repcap.Deembedding.Nr1)
def repcap_deembedding_set(self, deembedding: repcap.Deembedding) -> 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 Deembedding.Default.
Default value after init: Deembedding.Nr1
"""
self._cmd_group.set_repcap_enum_value(deembedding)
def repcap_deembedding_get(self) -> repcap.Deembedding:
"""
Returns the current default repeated capability for the child set/get methods.
"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@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 name(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_name'):
from .Name import NameCls
self._name = NameCls(self._core, self._cmd_group)
return self._name
@property
def ccount(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_ccount'):
from .Ccount import CcountCls
self._ccount = CcountCls(self._core, self._cmd_group)
return self._ccount
@property
def bandwidth(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_bandwidth'):
from .Bandwidth import BandwidthCls
self._bandwidth = BandwidthCls(self._core, self._cmd_group)
return self._bandwidth
@property
def realtime(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_realtime'):
from .Realtime import RealtimeCls
self._realtime = RealtimeCls(self._core, self._cmd_group)
return self._realtime
@property
def cmpDelay(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_cmpDelay'):
from .CmpDelay import CmpDelayCls
self._cmpDelay = CmpDelayCls(self._core, self._cmd_group)
return self._cmpDelay
@property
def add(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_add'):
from .Add import AddCls
self._add = AddCls(self._core, self._cmd_group)
return self._add
@property
def remove(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_remove'):
from .Remove import RemoveCls
self._remove = RemoveCls(self._core, self._cmd_group)
return self._remove
@property
def cascade(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_cascade'):
from .Cascade import CascadeCls
self._cascade = CascadeCls(self._core, self._cmd_group)
return self._cascade
@property
def component(self):
"""
| Commands in total: 25
| Subgroups: 18
| Direct child commands: 0
"""
if not hasattr(self, '_component'):
from .Component import ComponentCls
self._component = ComponentCls(self._core, self._cmd_group)
return self._component
[docs]
def preset(self, deembedding=repcap.Deembedding.Default, opc_timeout_ms: int = -1) -> None:
"""
``DEEMbedding<*>:PRESet`` \n
Snippet: ``driver.deembedding.preset(deembedding = repcap.Deembedding.Default)`` \n
Sets the complete deembedding configuration to the default values. Use this command always before setting up the
deembedding, because ``*RST`` does not affect the deembedding settings.
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
self._core.io.write_with_opc(f'DEEMbedding{deembedding_cmd_val}:PRESet', opc_timeout_ms)
[docs]
def save(self, deembedding=repcap.Deembedding.Default) -> None:
"""
``DEEMbedding<*>:SAVE`` \n
Snippet: ``driver.deembedding.save(deembedding = repcap.Deembedding.Default)`` \n
Saves the deembedding configuration to the file specified with method ``RsRtx.deembedding.name.set()`` .
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
"""
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
self._core.io.write(f'DEEMbedding{deembedding_cmd_val}:SAVE')
[docs]
def save_and_wait(self, deembedding=repcap.Deembedding.Default, opc_timeout_ms: int = -1) -> None:
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
"""
``DEEMbedding<*>:SAVE`` \n
Snippet: ``driver.deembedding.save_and_wait(deembedding = repcap.Deembedding.Default)`` \n
Saves the deembedding configuration to the file specified with method ``RsRtx.deembedding.name.set()`` .
Same as save, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'DEEMbedding{deembedding_cmd_val}:SAVE', opc_timeout_ms)
[docs]
def open(self, deembedding=repcap.Deembedding.Default) -> None:
"""
``DEEMbedding<*>:OPEN`` \n
Snippet: ``driver.deembedding.open(deembedding = repcap.Deembedding.Default)`` \n
Opens and loads the deembedding configuration from the file specified with method ``RsRtx.deembedding.name.set()`` .
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
"""
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
self._core.io.write(f'DEEMbedding{deembedding_cmd_val}:OPEN')
[docs]
def open_and_wait(self, deembedding=repcap.Deembedding.Default, opc_timeout_ms: int = -1) -> None:
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
"""
``DEEMbedding<*>:OPEN`` \n
Snippet: ``driver.deembedding.open_and_wait(deembedding = repcap.Deembedding.Default)`` \n
Opens and loads the deembedding configuration from the file specified with method ``RsRtx.deembedding.name.set()`` .
Same as open, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'DEEMbedding{deembedding_cmd_val}:OPEN', opc_timeout_ms)
[docs]
def delete(self, deembedding=repcap.Deembedding.Default) -> None:
"""
``DEEMbedding<*>:DELete`` \n
Snippet: ``driver.deembedding.delete(deembedding = repcap.Deembedding.Default)`` \n
Deletes the deembedding configuration file specified with method ``RsRtx.deembedding.name.set()`` .
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
"""
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
self._core.io.write(f'DEEMbedding{deembedding_cmd_val}:DELete')
[docs]
def delete_and_wait(self, deembedding=repcap.Deembedding.Default, opc_timeout_ms: int = -1) -> None:
deembedding_cmd_val = self._cmd_group.get_repcap_cmd_value(deembedding, repcap.Deembedding)
"""
``DEEMbedding<*>:DELete`` \n
Snippet: ``driver.deembedding.delete_and_wait(deembedding = repcap.Deembedding.Default)`` \n
Deletes the deembedding configuration file specified with method ``RsRtx.deembedding.name.set()`` .
Same as delete, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param deembedding: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Deembedding')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'DEEMbedding{deembedding_cmd_val}:DELete', opc_timeout_ms)
def clone(self) -> 'DeembeddingCls':
"""
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 = DeembeddingCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group