from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import enums
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FunctionCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("function", core, parent)
[docs]
def set(self, type_py: enums.CursorType, cursor=repcap.Cursor.Default) -> None:
"""
``CURSor<*>:FUNCtion`` \n
Snippet: ``driver.cursor.function.set(type_py = enums.CursorType.HORizontal, cursor = repcap.Cursor.Default)`` \n
Defines the cursor type to be used for the measurement.
:param type_py: VERTical | HORizontal | PAIRed \n
- HORizontal: A pair of horizontal cursor lines. Not available for measurements on multiple sources.
- VERTical: A pair of vertical cursor lines. Not available for measurements on multiple sources.
- PAIRed: Both vertical and horizontal cursor line pairs.
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
"""
param = Conversions.enum_scalar_to_str(type_py, enums.CursorType)
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
self._core.io.write(f'CURSor{cursor_cmd_val}:FUNCtion {param}')
# noinspection PyTypeChecker
[docs]
def get(self, cursor=repcap.Cursor.Default) -> enums.CursorType:
"""
``CURSor<*>:FUNCtion`` \n
Snippet: ``value: enums.CursorType = driver.cursor.function.get(cursor = repcap.Cursor.Default)`` \n
Defines the cursor type to be used for the measurement.
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
:return: type_py: VERTical | HORizontal | PAIRed \n
- HORizontal: A pair of horizontal cursor lines. Not available for measurements on multiple sources.
- VERTical: A pair of vertical cursor lines. Not available for measurements on multiple sources.
- PAIRed: Both vertical and horizontal cursor line pairs.
"""
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
response = self._core.io.query_str(f'CURSor{cursor_cmd_val}:FUNCtion?')
return Conversions.str_to_scalar_enum(response, enums.CursorType)