from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.Types import DataType
from ....Internal.ArgSingleList import ArgSingleList
from ....Internal.ArgSingle import ArgSingle
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class BeepCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("beep", core, parent)
[docs]
def set(self, mask_test: str, beep: enums.BeepMode) -> None:
"""
``MTESt:ONViolation:BEEP`` \n
Snippet: ``driver.mtest.onViolation.beep.set(mask_test = 'abc', beep = enums.BeepMode.NOACtion)`` \n
Generates a beep sound for the specified event.
:param mask_test: String with the name of the mask test
:param beep: See 'Event parameter'
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('mask_test', mask_test, DataType.String), ArgSingle('beep', beep, DataType.Enum, enums.BeepMode))
self._core.io.write_with_opc(f'MTESt:ONViolation:BEEP {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
def get(self, mask_test: str) -> enums.BeepMode:
"""
``MTESt:ONViolation:BEEP`` \n
Snippet: ``value: enums.BeepMode = driver.mtest.onViolation.beep.get(mask_test = 'abc')`` \n
Generates a beep sound for the specified event.
:param mask_test: String with the name of the mask test
:return: beep: See 'Event parameter'
"""
param = Conversions.value_to_quoted_str(mask_test)
response = self._core.io.query_str_with_opc(f'MTESt:ONViolation:BEEP? {param}')
return Conversions.str_to_scalar_enum(response, enums.BeepMode)