Source code for rsrtx.Implementations.Lane.Equalization.Training.RefWaveform

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


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

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



	def set(self, ref_wfm: enums.SignalSource, lane=repcap.Lane.Default) -> None:
		"""
		``LANE<*>:EQUalization:TRAining:REFWaveform`` \n
		Snippet: ``driver.lane.equalization.training.refWaveform.set(ref_wfm = enums.SignalSource.AJ1, lane = repcap.Lane.Default)`` \n
		Selects the reference waveform to be used for the filter training,
		if method ``RsRtx.lane.equalization.training.mode.set()`` is set to REFerence.

		:param ref_wfm: NONE | R1 | R2 | R3 | R4
		:param lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
		"""
		param = Conversions.enum_scalar_to_str(ref_wfm, enums.SignalSource)
		lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
		self._core.io.write_with_opc(f'LANE{lane_cmd_val}:EQUalization:TRAining:REFWaveform {param}')


	# noinspection PyTypeChecker


	def get(self, lane=repcap.Lane.Default) -> enums.SignalSource:
		"""
		``LANE<*>:EQUalization:TRAining:REFWaveform`` \n
		Snippet: ``value: enums.SignalSource = driver.lane.equalization.training.refWaveform.get(lane = repcap.Lane.Default)`` \n
		Selects the reference waveform to be used for the filter training,
		if method ``RsRtx.lane.equalization.training.mode.set()`` is set to REFerence.

		:param lane: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Lane')
		:return: ref_wfm: NONE | R1 | R2 | R3 | R4
		"""
		lane_cmd_val = self._cmd_group.get_repcap_cmd_value(lane, repcap.Lane)
		response = self._core.io.query_str_with_opc(f'LANE{lane_cmd_val}:EQUalization:TRAining:REFWaveform?')
		return Conversions.str_to_scalar_enum(response, enums.SignalSource)