Source code for rsrtx.Implementations.Trigger.Sent.FormError

from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FormErrorCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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



	def set(self, form_error: bool, trigger=repcap.Trigger.Default) -> None:
		"""
		``TRIGger<*>:SENT:FORMerror`` \n
		Snippet: ``driver.trigger.sent.formError.set(form_error = False, trigger = repcap.Trigger.Default)`` \n
		Triggers on format errors in serial messages. A form error occurs when at least one of the transmission sequences that
		form a serial message has an error. To trigger on an error event, select the corresponding trigger type with
		TRIGger<m>:SENT:TYPE ERRC.

		:param form_error: OFF | ON
		:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
		"""
		param = Conversions.bool_to_str(form_error)
		trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
		self._core.io.write(f'TRIGger{trigger_cmd_val}:SENT:FORMerror {param}')




	def get(self, trigger=repcap.Trigger.Default) -> bool:
		"""
		``TRIGger<*>:SENT:FORMerror`` \n
		Snippet: ``value: bool = driver.trigger.sent.formError.get(trigger = repcap.Trigger.Default)`` \n
		Triggers on format errors in serial messages. A form error occurs when at least one of the transmission sequences that
		form a serial message has an error. To trigger on an error event, select the corresponding trigger type with
		TRIGger<m>:SENT:TYPE ERRC.

		:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
		:return: form_error: OFF | ON
		"""
		trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
		response = self._core.io.query_str(f'TRIGger{trigger_cmd_val}:SENT:FORMerror?')
		return Conversions.str_to_bool(response)