Source code for RsFsw.Implementations.Applications.K6_Pulse.Sense.Pulse.Timing.Prf.Maximum

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class MaximumCls:
	"""Maximum commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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

	def get(self, query_range: enums.SelectionRangeB) -> str:
		"""SCPI: [SENSe]:PULSe:TIMing:PRF:MAXimum \n
		Snippet: value: str = driver.applications.k6Pulse.sense.pulse.timing.prf.maximum.get(query_range = enums.SelectionRangeB.ALL) \n
		Returns the statistical value for the Pulse Repetition Frequency (Hz) over the specified pulses. \n
			:param query_range: CURRent | ALL CURRent Detected pulses in the current capture buffer ALL All detected pulses in the entire measurement.
			:return: result: char_data"""
		param = Conversions.enum_scalar_to_str(query_range, enums.SelectionRangeB)
		response = self._core.io.query_str(f'SENSe:PULSe:TIMing:PRF:MAXimum? {param}')
		return trim_str_response(response)