Source code for rsrtx.Implementations.Layout.Zoom.Vertical.Relative.Start

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 StartCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("start", core, parent)

[docs] def set(self, diagram_group: str, zoom_diagram: str, relative_start: float) -> None: """ ``LAYout:ZOOM:VERTical:RELative:STARt`` \n Snippet: ``driver.layout.zoom.vertical.relative.start.set(diagram_group = 'abc', zoom_diagram = 'abc', relative_start = 1.0)`` \n Defines the lower limit of the zoom area on the y-axis. :param diagram_group: Name of the diagram on which the zoom area is based. :param zoom_diagram: Name of the zoom diagram :param relative_start: 0 to 100 """ param = ArgSingleList().compose_cmd_string(ArgSingle('diagram_group', diagram_group, DataType.String), ArgSingle('zoom_diagram', zoom_diagram, DataType.String), ArgSingle('relative_start', relative_start, DataType.Float)) self._core.io.write_with_opc(f'LAYout:ZOOM:VERTical:RELative:STARt {param}'.rstrip())
[docs] def get(self, diagram_group: str, zoom_diagram: str) -> float: """ ``LAYout:ZOOM:VERTical:RELative:STARt`` \n Snippet: ``value: float = driver.layout.zoom.vertical.relative.start.get(diagram_group = 'abc', zoom_diagram = 'abc')`` \n Defines the lower limit of the zoom area on the y-axis. :param diagram_group: Name of the diagram on which the zoom area is based. :param zoom_diagram: Name of the zoom diagram :return: relative_start: 0 to 100 """ param = ArgSingleList().compose_cmd_string(ArgSingle('diagram_group', diagram_group, DataType.String), ArgSingle('zoom_diagram', zoom_diagram, DataType.String)) response = self._core.io.query_str_with_opc(f'LAYout:ZOOM:VERTical:RELative:STARt? {param}'.rstrip()) return Conversions.str_to_float(response)