Source code for rsrtx.Implementations.Zvc.Z.Icurrent.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, state: bool, zvcProbe=repcap.ZvcProbe.Default, zvcChannel=repcap.ZvcChannel.Default) -> None: """ ``ZVC:Z<*>:I<*>[:STATe]`` \n Snippet: ``driver.zvc.z.icurrent.state.set(state = False, zvcProbe = repcap.ZvcProbe.Default, zvcChannel = repcap.ZvcChannel.Default)`` \n Enables the corresponding current channel of the probe. :param state: OFF | ON :param zvcProbe: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Z') :param zvcChannel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Icurrent') """ param = Conversions.bool_to_str(state) zvcProbe_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcProbe, repcap.ZvcProbe) zvcChannel_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcChannel, repcap.ZvcChannel) self._core.io.write_with_opc(f'ZVC:Z{zvcProbe_cmd_val}:I{zvcChannel_cmd_val}:STATe {param}')
[docs] def get(self, zvcProbe=repcap.ZvcProbe.Default, zvcChannel=repcap.ZvcChannel.Default) -> bool: """ ``ZVC:Z<*>:I<*>[:STATe]`` \n Snippet: ``value: bool = driver.zvc.z.icurrent.state.get(zvcProbe = repcap.ZvcProbe.Default, zvcChannel = repcap.ZvcChannel.Default)`` \n Enables the corresponding current channel of the probe. :param zvcProbe: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Z') :param zvcChannel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Icurrent') :return: state: OFF | ON """ zvcProbe_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcProbe, repcap.ZvcProbe) zvcChannel_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcChannel, repcap.ZvcChannel) response = self._core.io.query_str_with_opc(f'ZVC:Z{zvcProbe_cmd_val}:I{zvcChannel_cmd_val}:STATe?') return Conversions.str_to_bool(response)