Source code for rsrtx.Implementations.Measurement.EnvSelect

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

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

[docs] def set(self, envelope_curve: enums.EnvelopeCurve, measurement=repcap.Measurement.Default) -> None: """ ``MEASurement<*>:ENVSelect`` \n Snippet: ``driver.measurement.envSelect.set(envelope_curve = enums.EnvelopeCurve.BOTH, measurement = repcap.Measurement.Default)`` \n The command is only relevant for measurements on envelope waveforms. It selects the envelope to be used for measurement. :param envelope_curve: MIN: measures on the lower envelope MAX: measures on the upper envelope BOTH: the envelope is ignored and the waveform measured as usual :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') """ param = Conversions.enum_scalar_to_str(envelope_curve, enums.EnvelopeCurve) measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) self._core.io.write_with_opc(f'MEASurement{measurement_cmd_val}:ENVSelect {param}')
# noinspection PyTypeChecker
[docs] def get(self, measurement=repcap.Measurement.Default) -> enums.EnvelopeCurve: """ ``MEASurement<*>:ENVSelect`` \n Snippet: ``value: enums.EnvelopeCurve = driver.measurement.envSelect.get(measurement = repcap.Measurement.Default)`` \n The command is only relevant for measurements on envelope waveforms. It selects the envelope to be used for measurement. :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') :return: envelope_curve: MIN: measures on the lower envelope MAX: measures on the upper envelope BOTH: the envelope is ignored and the waveform measured as usual """ measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) response = self._core.io.query_str_with_opc(f'MEASurement{measurement_cmd_val}:ENVSelect?') return Conversions.str_to_scalar_enum(response, enums.EnvelopeCurve)