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, relative_center: float, histogram=repcap.Histogram.Default) -> None:
"""
``HISTogram<*>:WINDow:VERTical:RELative:POSition`` \n
Snippet: ``driver.histogram.window.vertical.relative.position.set(relative_center = 1.0, histogram = repcap.Histogram.Default)`` \n
Set the vertical window limits as relative values in % of the diagram height.
:param relative_center: 0 for position, start and stop, 1E-15 for span to 100
:param histogram: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Histogram')
"""
param = Conversions.decimal_value_to_str(relative_center)
histogram_cmd_val = self._cmd_group.get_repcap_cmd_value(histogram, repcap.Histogram)
self._core.io.write(f'HISTogram{histogram_cmd_val}:WINDow:VERTical:RELative:POSition {param}')
[docs]
def get(self, histogram=repcap.Histogram.Default) -> float:
"""
``HISTogram<*>:WINDow:VERTical:RELative:POSition`` \n
Snippet: ``value: float = driver.histogram.window.vertical.relative.position.get(histogram = repcap.Histogram.Default)`` \n
Set the vertical window limits as relative values in % of the diagram height.
:param histogram: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Histogram')
"""
histogram_cmd_val = self._cmd_group.get_repcap_cmd_value(histogram, repcap.Histogram)
response = self._core.io.query_str(f'HISTogram{histogram_cmd_val}:WINDow:VERTical:RELative:POSition?')
return Conversions.str_to_float(response)