from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PamReferenceCls:
"""
| Commands in total: 12
| Subgroups: 6
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pamReference", core, parent)
@property
def lvlDef(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_lvlDef'):
from .LvlDef import LvlDefCls
self._lvlDef = LvlDefCls(self._core, self._cmd_group)
return self._lvlDef
@property
def relLevel(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_relLevel'):
from .RelLevel import RelLevelCls
self._relLevel = RelLevelCls(self._core, self._cmd_group)
return self._relLevel
@property
def lower(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_lower'):
from .Lower import LowerCls
self._lower = LowerCls(self._core, self._cmd_group)
return self._lower
@property
def middle(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_middle'):
from .Middle import MiddleCls
self._middle = MiddleCls(self._core, self._cmd_group)
return self._middle
@property
def upper(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_upper'):
from .Upper import UpperCls
self._upper = UpperCls(self._core, self._cmd_group)
return self._upper
@property
def lvlJumpHeight(self):
"""
| Commands in total: 6
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_lvlJumpHeight'):
from .LvlJumpHeight import LvlJumpHeightCls
self._lvlJumpHeight = LvlJumpHeightCls(self._core, self._cmd_group)
return self._lvlJumpHeight
[docs]
def preset(self, refLevel=repcap.RefLevel.Default) -> None:
"""
``REFLevel<*>:PAMReference:PRESet`` \n
Snippet: ``driver.refLevel.pamReference.preset(refLevel = repcap.RefLevel.Default)`` \n
Presets the level jump height dependent reference levels according to the value of the selected method
``RsRtx.refLevel.pamReference.relLevel.set()`` .
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
"""
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
self._core.io.write(f'REFLevel{refLevel_cmd_val}:PAMReference:PRESet')
[docs]
def preset_and_wait(self, refLevel=repcap.RefLevel.Default, opc_timeout_ms: int = -1) -> None:
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
"""
``REFLevel<*>:PAMReference:PRESet`` \n
Snippet: ``driver.refLevel.pamReference.preset_and_wait(refLevel = repcap.RefLevel.Default)`` \n
Presets the level jump height dependent reference levels according to the value of the selected method
``RsRtx.refLevel.pamReference.relLevel.set()`` .
Same as preset, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'REFLevel{refLevel_cmd_val}:PAMReference:PRESet', opc_timeout_ms)
def clone(self) -> 'PamReferenceCls':
"""
Clones the group by creating new object from it and its whole existing subgroups.
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group.
"""
new_group = PamReferenceCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group