Source code for rsrtx.Implementations.Bus.Cmsb.Frame.Cell.FormatPy

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


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

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



	def set(self, cell_format: enums.BusDataFormat, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> None:
		"""
		``BUS<*>:CMSB:FRAMe<*>:CELL<*>:FORMat`` \n
		Snippet: ``driver.bus.cmsb.frame.cell.formatPy.set(cell_format = enums.BusDataFormat.ASCII, bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
		Selects the numeric data format for the command method ``RsRtx.bus.cmsb.frame.cell.condition.set()`` , as well as for the
		result and honeycomb display.

		:param cell_format: DEC | HEX | OCT | BIN \n
			- DEC: Decimal
			- HEX: Hexadecimal
			- OCT: Octal
			- BIN: Binary

		:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
		:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
		:param busCellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell')
		"""
		param = Conversions.enum_scalar_to_str(cell_format, enums.BusDataFormat)
		bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
		busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
		busCellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busCellNull, repcap.BusCellNull)
		self._core.io.write(f'BUS{bus_cmd_val}:CMSB:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:FORMat {param}')


	# noinspection PyTypeChecker


	def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> enums.BusDataFormat:
		"""
		``BUS<*>:CMSB:FRAMe<*>:CELL<*>:FORMat`` \n
		Snippet: ``value: enums.BusDataFormat = driver.bus.cmsb.frame.cell.formatPy.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
		Selects the numeric data format for the command method ``RsRtx.bus.cmsb.frame.cell.condition.set()`` , as well as for the
		result and honeycomb display.

		:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
		:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
		:param busCellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell')
		:return: cell_format: DEC | HEX | OCT | BIN \n
			- DEC: Decimal
			- HEX: Hexadecimal
			- OCT: Octal
			- BIN: Binary

		"""
		bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
		busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
		busCellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busCellNull, repcap.BusCellNull)
		response = self._core.io.query_str(f'BUS{bus_cmd_val}:CMSB:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:FORMat?')
		return Conversions.str_to_scalar_enum(response, enums.BusDataFormat)