Source code for rsrtx.Implementations.Mtest.OnViolation.SaveWaveform

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 SaveWaveformCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("saveWaveform", core, parent)



	def set(self, mask_test: str, save_wfm: enums.BeepMode) -> None:
		"""
		``MTESt:ONViolation:SAVewaveform`` \n
		Snippet: ``driver.mtest.onViolation.saveWaveform.set(mask_test = 'abc', save_wfm = enums.BeepMode.NOACtion)`` \n
		Saves the waveform data.

		:param mask_test: String with the name of the mask test
		:param save_wfm: See 'Event parameter'
		"""
		param = ArgSingleList().compose_cmd_string(ArgSingle('mask_test', mask_test, DataType.String), ArgSingle('save_wfm', save_wfm, DataType.Enum, enums.BeepMode))
		self._core.io.write_with_opc(f'MTESt:ONViolation:SAVewaveform {param}'.rstrip())


	# noinspection PyTypeChecker


	def get(self, mask_test: str) -> enums.BeepMode:
		"""
		``MTESt:ONViolation:SAVewaveform`` \n
		Snippet: ``value: enums.BeepMode = driver.mtest.onViolation.saveWaveform.get(mask_test = 'abc')`` \n
		Saves the waveform data.

		:param mask_test: String with the name of the mask test
		
		:return: save_wfm: See 'Event parameter'
		"""
		param = Conversions.value_to_quoted_str(mask_test)
		response = self._core.io.query_str_with_opc(f'MTESt:ONViolation:SAVewaveform? {param}')
		return Conversions.str_to_scalar_enum(response, enums.BeepMode)