Source code for rsrtx.Implementations.Measurement.Result.MaxCount

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
from .... import repcap


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

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

[docs] def set(self, meas_type: enums.MeasSpectrumParam, number: int, measurement=repcap.Measurement.Default) -> None: """ ``MEASurement<*>:RESult:MAXCount`` \n Snippet: ``driver.measurement.result.maxCount.set(meas_type = enums.MeasSpectrumParam.ACPower, number = 1, measurement = repcap.Measurement.Default)`` \n Defines the maximum number of peaks that are labeled in the diagram. :param meas_type: Only for peaklist measurements. For other measurement, this command returns an error. :param number: Maximum number of peaks :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') """ param = ArgSingleList().compose_cmd_string(ArgSingle('meas_type', meas_type, DataType.Enum, enums.MeasSpectrumParam), ArgSingle('number', number, DataType.Integer)) measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) self._core.io.write(f'MEASurement{measurement_cmd_val}:RESult:MAXCount {param}'.rstrip())
[docs] def get(self, meas_type: enums.MeasSpectrumParam, measurement=repcap.Measurement.Default) -> int: """ ``MEASurement<*>:RESult:MAXCount`` \n Snippet: ``value: int = driver.measurement.result.maxCount.get(meas_type = enums.MeasSpectrumParam.ACPower, measurement = repcap.Measurement.Default)`` \n Defines the maximum number of peaks that are labeled in the diagram. :param meas_type: Only for peaklist measurements. For other measurement, this command returns an error. :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') :return: number: Maximum number of peaks """ param = Conversions.enum_scalar_to_str(meas_type, enums.MeasSpectrumParam) measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) response = self._core.io.query_str(f'MEASurement{measurement_cmd_val}:RESult:MAXCount? {param}') return Conversions.str_to_int(response)