Source code for rsmxo.Implementations.Measurement.Result.Events.Count

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


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

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

[docs] def get(self, measIndex=repcap.MeasIndex.Default) -> int: """ ``MEASurement<*>:RESult:EVENts:COUNt`` \n Snippet: ``value: int = driver.measurement.result.events.count.get(measIndex = repcap.MeasIndex.Default)`` \n Returns the number of measured events in one acquisition. The command is relevant for measurements of all events, see method ``RsMxo.measurement.multiple.set()`` . :param measIndex: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') :return: count: Number of events """ measIndex_cmd_val = self._cmd_group.get_repcap_cmd_value(measIndex, repcap.MeasIndex) response = self._core.io.query_str(f'MEASurement{measIndex_cmd_val}:RESult:EVENts:COUNt?') return Conversions.str_to_int(response)