Source code for rsmxo.Implementations.Franalysis.Marker.Frequency

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


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

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

[docs] def set(self, frequency: float, marker=repcap.Marker.Default) -> None: """ ``FRANalysis:MARKer<*>:FREQuency`` \n Snippet: ``driver.franalysis.marker.frequency.set(frequency = 1.0, marker = repcap.Marker.Default)`` \n Sets the frequency for the specified marker, which defines the horizontal marker position. :param frequency: Numeric value in Hz :param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker') """ param = Conversions.decimal_value_to_str(frequency) marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker) self._core.io.write(f'FRANalysis:MARKer{marker_cmd_val}:FREQuency {param}')
[docs] def get(self, marker=repcap.Marker.Default) -> float: """ ``FRANalysis:MARKer<*>:FREQuency`` \n Snippet: ``value: float = driver.franalysis.marker.frequency.get(marker = repcap.Marker.Default)`` \n Sets the frequency for the specified marker, which defines the horizontal marker position. :param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker') :return: frequency: Numeric value in Hz """ marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker) response = self._core.io.query_str(f'FRANalysis:MARKer{marker_cmd_val}:FREQuency?') return Conversions.str_to_float(response)