Source code for rsmxo.Implementations.P3Phase.Harmonics.Result.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 get(self, power3PhaseMeas=repcap.Power3PhaseMeas.Default, result=repcap.Result.Default) -> float: """ ``P3PHase<*>:HARMonics:RESult<*>[:FREQuency]`` \n Snippet: ``value: float = driver.p3Phase.harmonics.result.frequency.get(power3PhaseMeas = repcap.Power3PhaseMeas.Default, result = repcap.Result.Default)`` \n Returns the frequency of the n-th harmonic. :param power3PhaseMeas: optional repeated capability selector. Default value: Nr1 (settable in the interface 'P3Phase') :param result: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Result') """ power3PhaseMeas_cmd_val = self._cmd_group.get_repcap_cmd_value(power3PhaseMeas, repcap.Power3PhaseMeas) result_cmd_val = self._cmd_group.get_repcap_cmd_value(result, repcap.Result) response = self._core.io.query_str(f'P3PHase{power3PhaseMeas_cmd_val}:HARMonics:RESult{result_cmd_val}:FREQuency?') return Conversions.str_to_float(response)