Source code for RsFsw.Implementations.Applications.K6_Pulse.Sense.Pulse.Id

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


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

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

[docs] def get(self, query_range: enums.SelectionRangeB) -> int: """ ``[SENSe]:PULSe:ID`` \n Snippet: ``value: int = driver.applications.k6Pulse.sense.pulse.id.get(query_range = enums.SelectionRangeB.ALL)`` \n Queries the ids of the detected pulses, i.e the unique index within the entire measurement (as opposed to method ``RsFsw.applications.k6Pulse.sense.pulse.number.get()`` ) . :param query_range: CURRent | ALL CURRent Detected pulses in the current capture buffer ALL All detected pulses in the entire measurement. """ param = Conversions.enum_scalar_to_str(query_range, enums.SelectionRangeB) response = self._core.io.query_str(f'SENSe:PULSe:ID? {param}') return Conversions.str_to_int(response)