Source code for rsmxo.Implementations.P3Phase.Harmonics.Available

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


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

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

[docs] def set(self, count: int=None, power3PhaseMeas=repcap.Power3PhaseMeas.Default, power3Phase=repcap.Power3Phase.Ix1) -> None: """ ``P3PHase<*>:HARMonics:AVAilable<*>`` \n Snippet: ``driver.p3Phase.harmonics.available.set(count = 1, power3PhaseMeas = repcap.Power3PhaseMeas.Default, power3Phase = repcap.Power3Phase.Ix1)`` \n Returns the number of measured harmonics for the individual phases. :param power3PhaseMeas: optional repeated capability selector. Default value: Nr1 (settable in the interface 'P3Phase') :param power3Phase: optional repeated capability selector. Default value: Ix1 """ param = '' if count: param = Conversions.decimal_value_to_str(count) power3PhaseMeas_cmd_val = self._cmd_group.get_repcap_cmd_value(power3PhaseMeas, repcap.Power3PhaseMeas) power3Phase_cmd_val = self._cmd_group.get_repcap_cmd_value(power3Phase, repcap.Power3Phase) self._core.io.write(f'P3PHase{power3PhaseMeas_cmd_val}:HARMonics:AVAilable{power3Phase_cmd_val} {param}'.strip())
[docs] def get(self, power3PhaseMeas=repcap.Power3PhaseMeas.Default, power3Phase=repcap.Power3Phase.Ix1) -> int: """ ``P3PHase<*>:HARMonics:AVAilable<*>`` \n Snippet: ``value: int = driver.p3Phase.harmonics.available.get(power3PhaseMeas = repcap.Power3PhaseMeas.Default, power3Phase = repcap.Power3Phase.Ix1)`` \n Returns the number of measured harmonics for the individual phases. :param power3PhaseMeas: optional repeated capability selector. Default value: Nr1 (settable in the interface 'P3Phase') :param power3Phase: optional repeated capability selector. Default value: Ix1 """ power3PhaseMeas_cmd_val = self._cmd_group.get_repcap_cmd_value(power3PhaseMeas, repcap.Power3PhaseMeas) power3Phase_cmd_val = self._cmd_group.get_repcap_cmd_value(power3Phase, repcap.Power3Phase) response = self._core.io.query_str(f'P3PHase{power3PhaseMeas_cmd_val}:HARMonics:AVAilable{power3Phase_cmd_val}?') return Conversions.str_to_int(response)