from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class NhorizontalCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("nhorizontal", core, parent)
[docs]
def set(self, max_num_periodic_components_horiz: int, advJitter=repcap.AdvJitter.Default) -> None:
"""
``ADVJitter<*>:DCOMposition:NHORizontal`` \n
Snippet: ``driver.advJitter.dcomPosition.nhorizontal.set(max_num_periodic_components_horiz = 1, advJitter = repcap.AdvJitter.Default)`` \n
Sets the maximum number of periodic components in the horizontal direction that are considered for the measurement.
If the actual number of periodic components is higher than the set value, they are considered for the random jitter
component.
:param max_num_periodic_components_horiz: 0 to 10
:param advJitter: optional repeated capability selector. Default value: Nr1 (settable in the interface 'AdvJitter')
"""
param = Conversions.decimal_value_to_str(max_num_periodic_components_horiz)
advJitter_cmd_val = self._cmd_group.get_repcap_cmd_value(advJitter, repcap.AdvJitter)
self._core.io.write(f'ADVJitter{advJitter_cmd_val}:DCOMposition:NHORizontal {param}')
[docs]
def get(self, advJitter=repcap.AdvJitter.Default) -> int:
"""
``ADVJitter<*>:DCOMposition:NHORizontal`` \n
Snippet: ``value: int = driver.advJitter.dcomPosition.nhorizontal.get(advJitter = repcap.AdvJitter.Default)`` \n
Sets the maximum number of periodic components in the horizontal direction that are considered for the measurement.
If the actual number of periodic components is higher than the set value, they are considered for the random jitter
component.
:param advJitter: optional repeated capability selector. Default value: Nr1 (settable in the interface 'AdvJitter')
"""
advJitter_cmd_val = self._cmd_group.get_repcap_cmd_value(advJitter, repcap.AdvJitter)
response = self._core.io.query_str(f'ADVJitter{advJitter_cmd_val}:DCOMposition:NHORizontal?')
return Conversions.str_to_int(response)