Source code for rsmxo.Implementations.Cursor.Count

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CountCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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

[docs] def set(self, count: int=None, cursor=repcap.Cursor.Default) -> None: """ ``CURSor<*>:COUNt`` \n Snippet: ``driver.cursor.count.set(count = 1, cursor = repcap.Cursor.Default)`` \n Returns the maximum number of cursor sets, which is the maximum value for the cursor suffix. :param count: Maximum number of cursor sets :param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor') """ param = '' if count: param = Conversions.decimal_value_to_str(count) cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor) self._core.io.write(f'CURSor{cursor_cmd_val}:COUNt {param}'.strip())
[docs] def get(self, cursor=repcap.Cursor.Default) -> int: """ ``CURSor<*>:COUNt`` \n Snippet: ``value: int = driver.cursor.count.get(cursor = repcap.Cursor.Default)`` \n Returns the maximum number of cursor sets, which is the maximum value for the cursor suffix. :param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor') :return: count: Maximum number of cursor sets """ cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor) response = self._core.io.query_str(f'CURSor{cursor_cmd_val}:COUNt?') return Conversions.str_to_int(response)