from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class LimitCls:
"""Limit commands group definition. 1 total commands, 0 Subgroups, 1 group commands
Repeated Capability: Window, default value after init: Window.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_window_get', 'repcap_window_set', repcap.Window.Nr1)
def repcap_window_set(self, window: repcap.Window) -> 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 Window.Default
Default value after init: Window.Nr1"""
self._cmd_group.set_repcap_enum_value(window)
def repcap_window_get(self) -> repcap.Window:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
[docs] def set(self, filename: str, window=repcap.Window.Default) -> None:
"""SCPI: MMEMory:LOAD<n>:LIMit \n
Snippet: driver.applications.k14Xnr5G.massMemory.load.limit.set(filename = 'abc', window = repcap.Window.Default) \n
Loads the limit line from the selected file in .CSV format. \n
:param filename: String containing the path and name of the CSV import file.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit')
"""
param = Conversions.value_to_quoted_str(filename)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'MMEMory:LOAD{window_cmd_val}:LIMit {param}')
[docs] def get(self, window=repcap.Window.Default) -> str:
"""SCPI: MMEMory:LOAD<n>:LIMit \n
Snippet: value: str = driver.applications.k14Xnr5G.massMemory.load.limit.get(window = repcap.Window.Default) \n
Loads the limit line from the selected file in .CSV format. \n
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit')
:return: filename: String containing the path and name of the CSV import file."""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'MMEMory:LOAD{window_cmd_val}:LIMit?')
return trim_str_response(response)
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