Source code for RsSmbv.Implementations.Display

from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DisplayCls:
	"""
	| Commands in total: 19
	| Subgroups: 7
	| Direct child commands: 3
	"""

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

	@property
	def annotation(self):
		"""
		| Commands in total: 3
		| Subgroups: 3
		| Direct child commands: 0
		"""
		if not hasattr(self, '_annotation'):
			from .Annotation import AnnotationCls
			self._annotation = AnnotationCls(self._core, self._cmd_group)
		return self._annotation

	@property
	def button(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_button'):
			from .Button import ButtonCls
			self._button = ButtonCls(self._core, self._cmd_group)
		return self._button

	@property
	def dialog(self):
		"""
		| Commands in total: 4
		| Subgroups: 0
		| Direct child commands: 4
		"""
		if not hasattr(self, '_dialog'):
			from .Dialog import DialogCls
			self._dialog = DialogCls(self._core, self._cmd_group)
		return self._dialog

	@property
	def psave(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_psave'):
			from .Psave import PsaveCls
			self._psave = PsaveCls(self._core, self._cmd_group)
		return self._psave

	@property
	def touch(self):
		"""
		| Commands in total: 1
		| Subgroups: 1
		| Direct child commands: 0
		"""
		if not hasattr(self, '_touch'):
			from .Touch import TouchCls
			self._touch = TouchCls(self._core, self._cmd_group)
		return self._touch

	@property
	def ukey(self):
		"""
		| Commands in total: 3
		| Subgroups: 1
		| Direct child commands: 2
		"""
		if not hasattr(self, '_ukey'):
			from .Ukey import UkeyCls
			self._ukey = UkeyCls(self._core, self._cmd_group)
		return self._ukey

	@property
	def update(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_update'):
			from .Update import UpdateCls
			self._update = UpdateCls(self._core, self._cmd_group)
		return self._update

[docs] def get_brightness(self) -> float: """ ``DISPlay:BRIGhtness`` \n Snippet: ``value: float = driver.display.get_brightness()`` \n Sets the brightness of the dispaly. :return: brightness: float Range: 1.0 to 20.0 """ response = self._core.io.query_str('DISPlay:BRIGhtness?') return Conversions.str_to_float(response)
[docs] def set_brightness(self, brightness: float) -> None: """ ``DISPlay:BRIGhtness`` \n Snippet: ``driver.display.set_brightness(brightness = 1.0)`` \n Sets the brightness of the dispaly. :param brightness: float Range: 1.0 to 20.0 """ param = Conversions.decimal_value_to_str(brightness) self._core.io.write(f'DISPlay:BRIGhtness {param}')
[docs] def set_focus_object(self, obj_name: str) -> None: """ ``DISPlay:FOCusobject`` \n Snippet: ``driver.display.set_focus_object(obj_name = 'abc')`` \n No help available """ param = Conversions.value_to_quoted_str(obj_name) self._core.io.write(f'DISPlay:FOCusobject {param}')
[docs] def set_message(self, message: str) -> None: """ ``DISPlay:MESSage`` \n Snippet: ``driver.display.set_message(message = 'abc')`` \n No help available """ param = Conversions.value_to_quoted_str(message) self._core.io.write(f'DISPlay:MESSage {param}')
def clone(self) -> 'DisplayCls': """ Clones the group by creating new object from it and its whole existing subgroups. Also copies all the existing default Repeated Capabilities setting, which you can change independently without affecting the original group. """ new_group = DisplayCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group