Source code for rsrtx.Implementations.Wgenerator.Coupling.State

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


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

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

[docs] def set(self, cpl_enab_st: bool, wgenerator=repcap.Wgenerator.Default) -> None: """ ``WGENerator<*>:COUPling:STATe`` \n Snippet: ``driver.wgenerator.coupling.state.set(cpl_enab_st = False, wgenerator = repcap.Wgenerator.Default)`` \n Enables the coupling of the generators, with the selected set of parameters: amplitude, frequency and noise. :param cpl_enab_st: OFF | ON :param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') """ param = Conversions.bool_to_str(cpl_enab_st) wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator) self._core.io.write(f'WGENerator{wgenerator_cmd_val}:COUPling:STATe {param}')
[docs] def get(self, wgenerator=repcap.Wgenerator.Default) -> bool: """ ``WGENerator<*>:COUPling:STATe`` \n Snippet: ``value: bool = driver.wgenerator.coupling.state.get(wgenerator = repcap.Wgenerator.Default)`` \n Enables the coupling of the generators, with the selected set of parameters: amplitude, frequency and noise. :param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') """ wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator) response = self._core.io.query_str(f'WGENerator{wgenerator_cmd_val}:COUPling:STATe?') return Conversions.str_to_bool(response)