from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class LimitCls:
"""Limit commands group definition. 18 total commands, 11 Subgroups, 2 group commands
Repeated Capability: LimitIx, default value after init: LimitIx.Nr1"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("limit", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_limitIx_get', 'repcap_limitIx_set', repcap.LimitIx.Nr1)
def repcap_limitIx_set(self, limitIx: repcap.LimitIx) -> 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 LimitIx.Default
Default value after init: LimitIx.Nr1"""
self._cmd_group.set_repcap_enum_value(limitIx)
def repcap_limitIx_get(self) -> repcap.LimitIx:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def active(self):
"""active commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_active'):
from .Active import ActiveCls
self._active = ActiveCls(self._core, self._cmd_group)
return self._active
@property
def trace(self):
"""trace commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_trace'):
from .Trace import TraceCls
self._trace = TraceCls(self._core, self._cmd_group)
return self._trace
@property
def state(self):
"""state commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_state'):
from .State import StateCls
self._state = StateCls(self._core, self._cmd_group)
return self._state
@property
def fail(self):
"""fail commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_fail'):
from .Fail import FailCls
self._fail = FailCls(self._core, self._cmd_group)
return self._fail
@property
def clear(self):
"""clear commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_clear'):
from .Clear import ClearCls
self._clear = ClearCls(self._core, self._cmd_group)
return self._clear
@property
def comment(self):
"""comment commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_comment'):
from .Comment import CommentCls
self._comment = CommentCls(self._core, self._cmd_group)
return self._comment
@property
def name(self):
"""name commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_name'):
from .Name import NameCls
self._name = NameCls(self._core, self._cmd_group)
return self._name
@property
def auto(self):
"""auto commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_auto'):
from .Auto import AutoCls
self._auto = AutoCls(self._core, self._cmd_group)
return self._auto
@property
def control(self):
"""control commands group. 2 Sub-classes, 0 commands."""
if not hasattr(self, '_control'):
from .Control import ControlCls
self._control = ControlCls(self._core, self._cmd_group)
return self._control
@property
def lower(self):
"""lower commands group. 3 Sub-classes, 0 commands."""
if not hasattr(self, '_lower'):
from .Lower import LowerCls
self._lower = LowerCls(self._core, self._cmd_group)
return self._lower
@property
def upper(self):
"""upper commands group. 3 Sub-classes, 0 commands."""
if not hasattr(self, '_upper'):
from .Upper import UpperCls
self._upper = UpperCls(self._core, self._cmd_group)
return self._upper
[docs] def copy(self, line: int, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default) -> None:
"""SCPI: CALCulate<n>:LIMit<li>:COPY \n
Snippet: driver.applications.k40PhaseNoise.calculate.limit.copy(line = 1, window = repcap.Window.Default, limitIx = repcap.LimitIx.Default) \n
Copies a limit line. \n
:param line: 1 to 8 number of the new limit line name String containing the name of the limit line.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit')
"""
param = Conversions.decimal_value_to_str(line)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx)
self._core.io.write(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:COPY {param}')
[docs] def delete(self, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default) -> None:
"""SCPI: CALCulate<n>:LIMit<li>:DELete \n
Snippet: driver.applications.k40PhaseNoise.calculate.limit.delete(window = repcap.Window.Default, limitIx = repcap.LimitIx.Default) \n
Deletes a limit line. \n
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit')
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx)
self._core.io.write(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:DELete')
[docs] def delete_with_opc(self, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default, opc_timeout_ms: int = -1) -> None:
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx)
"""SCPI: CALCulate<n>:LIMit<li>:DELete \n
Snippet: driver.applications.k40PhaseNoise.calculate.limit.delete_with_opc(window = repcap.Window.Default, limitIx = repcap.LimitIx.Default) \n
Deletes a limit line. \n
Same as delete, but waits for the operation to complete before continuing further. Use the RsFsw.utilities.opc_timeout_set() to set the timeout value. \n
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:DELete', opc_timeout_ms)
def clone(self) -> 'LimitCls':
"""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 = LimitCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group