from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PositionCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("position", core, parent)
[docs]
def set(self, vertical_pos: float, annotation=repcap.Annotation.Default) -> None:
"""
``DISPlay:ANNotation:RECTangle<*>:VERTical:POSition`` \n
Snippet: ``driver.display.annotation.rectangle.vertical.position.set(vertical_pos = 1.0, annotation = repcap.Annotation.Default)`` \n
Sets the vertical position of the lower edge of the rectangle annotation. See also 'Defining the position of the
annotation'.
:param vertical_pos: In % of the screen
:param annotation: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Annotation')
"""
param = Conversions.decimal_value_to_str(vertical_pos)
annotation_cmd_val = self._cmd_group.get_repcap_cmd_value(annotation, repcap.Annotation)
self._core.io.write(f'DISPlay:ANNotation:RECTangle{annotation_cmd_val}:VERTical:POSition {param}')
[docs]
def get(self, annotation=repcap.Annotation.Default) -> float:
"""
``DISPlay:ANNotation:RECTangle<*>:VERTical:POSition`` \n
Snippet: ``value: float = driver.display.annotation.rectangle.vertical.position.get(annotation = repcap.Annotation.Default)`` \n
Sets the vertical position of the lower edge of the rectangle annotation. See also 'Defining the position of the
annotation'.
:param annotation: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Annotation')
:return: vertical_pos: In % of the screen
"""
annotation_cmd_val = self._cmd_group.get_repcap_cmd_value(annotation, repcap.Annotation)
response = self._core.io.query_str(f'DISPlay:ANNotation:RECTangle{annotation_cmd_val}:VERTical:POSition?')
return Conversions.str_to_float(response)