Source code for rsrtx.Implementations.Bus.Parallel.Data.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, data_format: enums.BusDataFormat, bus=repcap.Bus.Default) -> None:
		"""
		``BUS<*>:PARallel:DATA:FORMat`` \n
		Snippet: ``driver.bus.parallel.data.formatPy.set(data_format = enums.BusDataFormat.ASCII, bus = repcap.Bus.Default)`` \n
		Sets the number format for decoded data values on the display for the indicated parallel bus. It sets also the number
		representation for remote data transfer with method ``RsRtx.bus.parallel.data.values.get()`` .

		:param data_format: For method ``RsRtx.bus.parallel.display.btyp.set()``: HEX | OCT | BIN | ASCII | ASCii | SIGN | USIG For method ``RsRtx.bus.parallel.display.btyp.set()``: SIGN | USIG
		:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
		"""
		param = Conversions.enum_scalar_to_str(data_format, enums.BusDataFormat)
		bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
		self._core.io.write(f'BUS{bus_cmd_val}:PARallel:DATA:FORMat {param}')


	# noinspection PyTypeChecker


	def get(self, bus=repcap.Bus.Default) -> enums.BusDataFormat:
		"""
		``BUS<*>:PARallel:DATA:FORMat`` \n
		Snippet: ``value: enums.BusDataFormat = driver.bus.parallel.data.formatPy.get(bus = repcap.Bus.Default)`` \n
		Sets the number format for decoded data values on the display for the indicated parallel bus. It sets also the number
		representation for remote data transfer with method ``RsRtx.bus.parallel.data.values.get()`` .

		:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
		:return: data_format: For method ``RsRtx.bus.parallel.display.btyp.set()``: HEX | OCT | BIN | ASCII | ASCii | SIGN | USIG For method ``RsRtx.bus.parallel.display.btyp.set()``: SIGN | USIG
		"""
		bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
		response = self._core.io.query_str(f'BUS{bus_cmd_val}:PARallel:DATA:FORMat?')
		return Conversions.str_to_scalar_enum(response, enums.BusDataFormat)