from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class UseCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("use", core, parent)
[docs]
def set(self, use_zro_comp_offss: bool, zvcProbe=repcap.ZvcProbe.Default, zvcChannel=repcap.ZvcChannel.Default) -> None:
"""
``ZVC:Z<*>:I<*>:ZERComp:USE`` \n
Snippet: ``driver.zvc.z.icurrent.zerComp.use.set(use_zro_comp_offss = False, zvcProbe = repcap.ZvcProbe.Default, zvcChannel = repcap.ZvcChannel.Default)`` \n
Enables the automatic compensation of the measured zero offset.
:param use_zro_comp_offss: 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(use_zro_comp_offss)
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}:ZERComp:USE {param}')
[docs]
def get(self, zvcProbe=repcap.ZvcProbe.Default, zvcChannel=repcap.ZvcChannel.Default) -> bool:
"""
``ZVC:Z<*>:I<*>:ZERComp:USE`` \n
Snippet: ``value: bool = driver.zvc.z.icurrent.zerComp.use.get(zvcProbe = repcap.ZvcProbe.Default, zvcChannel = repcap.ZvcChannel.Default)`` \n
Enables the automatic compensation of the measured zero offset.
: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')
"""
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}:ZERComp:USE?')
return Conversions.str_to_bool(response)