Source code for rsrtx.Implementations.Measurement.Statistics.Mode

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

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

[docs] def set(self, reset_mode: enums.StatisticMode, measurement=repcap.Measurement.Default) -> None: """ ``MEASurement<*>:STATistics:MODE`` \n Snippet: ``driver.measurement.statistics.mode.set(reset_mode = enums.StatisticMode.MEAS, measurement = repcap.Measurement.Default)`` \n Defines when the statistics for long term measurements are reset. :param reset_mode: TIME | WFMS | MEAS \n - TIME: Sets one long term measurement point after the time defined using MEASurementmg:STATistics:RTIMe. - WFMS - Waveforms: Sets one long term measurement point after a number of acquired waveforms defined using MEASurementmg:STATistics:RCOunt. - MEAS: Sets one long term measurement point after a number of measurement results. :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') """ param = Conversions.enum_scalar_to_str(reset_mode, enums.StatisticMode) measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) self._core.io.write_with_opc(f'MEASurement{measurement_cmd_val}:STATistics:MODE {param}')
# noinspection PyTypeChecker
[docs] def get(self, measurement=repcap.Measurement.Default) -> enums.StatisticMode: """ ``MEASurement<*>:STATistics:MODE`` \n Snippet: ``value: enums.StatisticMode = driver.measurement.statistics.mode.get(measurement = repcap.Measurement.Default)`` \n Defines when the statistics for long term measurements are reset. :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') :return: reset_mode: TIME | WFMS | MEAS \n - TIME: Sets one long term measurement point after the time defined using MEASurementmg:STATistics:RTIMe. - WFMS - Waveforms: Sets one long term measurement point after a number of acquired waveforms defined using MEASurementmg:STATistics:RCOunt. - MEAS: Sets one long term measurement point after a number of measurement results. """ 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}:STATistics:MODE?') return Conversions.str_to_scalar_enum(response, enums.StatisticMode)