from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class EmbeddingCls:
"""
| Commands in total: 27
| Subgroups: 10
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("embedding", core, parent)
@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 differential(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_differential'):
from .Differential import DifferentialCls
self._differential = DifferentialCls(self._core, self._cmd_group)
return self._differential
@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 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: 15
| Subgroups: 15
| 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, lane=repcap.Lane.Default, opc_timeout_ms: int = -1) -> None:
"""
``LANE<*>:EMBedding:PRESet`` \n
Snippet: ``driver.lane.embedding.preset(lane = repcap.Lane.Default)`` \n
Sets the complete embedding configuration to the default values.
:param lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
self._core.io.write_with_opc(f'LANE{lane_cmd_val}:EMBedding:PRESet', opc_timeout_ms)
[docs]
def save(self, lane=repcap.Lane.Default) -> None:
"""
``LANE<*>:EMBedding:SAVE`` \n
Snippet: ``driver.lane.embedding.save(lane = repcap.Lane.Default)`` \n
Saves the embedding configuration to the file specified with method ``RsRtx.lane.embedding.name.set()`` .
:param lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
"""
lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
self._core.io.write(f'LANE{lane_cmd_val}:EMBedding:SAVE')
[docs]
def save_and_wait(self, lane=repcap.Lane.Default, opc_timeout_ms: int = -1) -> None:
lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
"""
``LANE<*>:EMBedding:SAVE`` \n
Snippet: ``driver.lane.embedding.save_and_wait(lane = repcap.Lane.Default)`` \n
Saves the embedding configuration to the file specified with method ``RsRtx.lane.embedding.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 lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'LANE{lane_cmd_val}:EMBedding:SAVE', opc_timeout_ms)
[docs]
def open(self, lane=repcap.Lane.Default) -> None:
"""
``LANE<*>:EMBedding:OPEN`` \n
Snippet: ``driver.lane.embedding.open(lane = repcap.Lane.Default)`` \n
Opens and loads the embedding configuration from the file specified with method ``RsRtx.lane.embedding.name.set()`` .
:param lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
"""
lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
self._core.io.write(f'LANE{lane_cmd_val}:EMBedding:OPEN')
[docs]
def open_and_wait(self, lane=repcap.Lane.Default, opc_timeout_ms: int = -1) -> None:
lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
"""
``LANE<*>:EMBedding:OPEN`` \n
Snippet: ``driver.lane.embedding.open_and_wait(lane = repcap.Lane.Default)`` \n
Opens and loads the embedding configuration from the file specified with method ``RsRtx.lane.embedding.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 lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'LANE{lane_cmd_val}:EMBedding:OPEN', opc_timeout_ms)
def clone(self) -> 'EmbeddingCls':
"""
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 = EmbeddingCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group