from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class StIconCls:
"""StIcon commands group definition. 3 total commands, 0 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("stIcon", core, parent)
[docs]
def get_enable(self) -> bool:
"""SCPI: SYSTem:BASE:STICon:ENABle \n
Snippet: value: bool = driver.system.base.stIcon.get_enable() \n
No command help available \n
:return: on_off: No help available
"""
response = self._core.io.query_str('SYSTem:BASE:STICon:ENABle?')
return Conversions.str_to_bool(response)
[docs]
def set_enable(self, on_off: bool) -> None:
"""SCPI: SYSTem:BASE:STICon:ENABle \n
Snippet: driver.system.base.stIcon.set_enable(on_off = False) \n
No command help available \n
:param on_off: No help available
"""
param = Conversions.bool_to_str(on_off)
self._core.io.write(f'SYSTem:BASE:STICon:ENABle {param}')
[docs]
def open(self) -> None:
"""SCPI: SYSTem:BASE:STICon:OPEN \n
Snippet: driver.system.base.stIcon.open() \n
No command help available \n
"""
self._core.io.write(f'SYSTem:BASE:STICon:OPEN')
[docs]
def open_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: SYSTem:BASE:STICon:OPEN \n
Snippet: driver.system.base.stIcon.open_with_opc() \n
No command help available \n
Same as open, but waits for the operation to complete before continuing further. Use the RsCMPX_Base.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'SYSTem:BASE:STICon:OPEN', opc_timeout_ms)
[docs]
def close(self) -> None:
"""SCPI: SYSTem:BASE:STICon:CLOSe \n
Snippet: driver.system.base.stIcon.close() \n
No command help available \n
"""
self._core.io.write(f'SYSTem:BASE:STICon:CLOSe')
[docs]
def close_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: SYSTem:BASE:STICon:CLOSe \n
Snippet: driver.system.base.stIcon.close_with_opc() \n
No command help available \n
Same as close, but waits for the operation to complete before continuing further. Use the RsCMPX_Base.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'SYSTem:BASE:STICon:CLOSe', opc_timeout_ms)