from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Types import DataType
from ......Internal.ArgSingleList import ArgSingleList
from ......Internal.ArgSingle import ArgSingle
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StopCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("stop", core, parent)
[docs]
def set(self, histogram: str, relative_stop: float) -> None:
"""
``LAYout:HISTogram:HORZ:RELative:STOP`` \n
Snippet: ``driver.layout.histogram.horz.relative.stop.set(histogram = 'abc', relative_stop = 1.0)`` \n
Defines the horizontal stop value of the histogram.
:param relative_stop: 0 to 100
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('histogram', histogram, DataType.String), ArgSingle('relative_stop', relative_stop, DataType.Float))
self._core.io.write_with_opc(f'LAYout:HISTogram:HORZ:RELative:STOP {param}'.rstrip())
[docs]
def get(self, histogram: str) -> float:
"""
``LAYout:HISTogram:HORZ:RELative:STOP`` \n
Snippet: ``value: float = driver.layout.histogram.horz.relative.stop.get(histogram = 'abc')`` \n
Defines the horizontal stop value of the histogram.
:return: relative_stop: 0 to 100
"""
param = Conversions.value_to_quoted_str(histogram)
response = self._core.io.query_str_with_opc(f'LAYout:HISTogram:HORZ:RELative:STOP? {param}')
return Conversions.str_to_float(response)