Source code for RsSmw.Implementations.Source.Bb.Evdo.User.Data.Pattern

from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal.Types import DataType
from .......Internal.StructBase import StructBase
from .......Internal.ArgStruct import ArgStruct
from .......Internal.ArgSingleList import ArgSingleList
from .......Internal.ArgSingle import ArgSingle
from ....... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection


class PatternCls:
	"""Pattern commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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



	def set(self, pattern: str, bitcount: int, userIx=repcap.UserIx.Default) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:USER<ST>:DATA:PATTern \n
		Snippet: driver.source.bb.evdo.user.data.pattern.set(pattern = rawAbc, bitcount = 1, userIx = repcap.UserIx.Default) \n
		Sets the data pattern for the data portion of the packets sent to the user. The most significant bit (MSB) of this value
		is the MSB of the packet and the word is repeated to fill all space within the packet. \n
			:param pattern: numeric
			:param bitcount: integer Range: 32 to 32
			:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
		"""
		param = ArgSingleList().compose_cmd_string(ArgSingle('pattern', pattern, DataType.RawString), ArgSingle('bitcount', bitcount, DataType.Integer))
		userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:USER{userIx_cmd_val}:DATA:PATTern {param}'.rstrip())


	# noinspection PyTypeChecker


	class PatternStruct(StructBase):
		"""Response structure. Fields: \n
			- 1 Pattern: str: numeric
			- 2 Bitcount: int: integer Range: 32 to 32"""
		__meta_args_list = [
			ArgStruct.scalar_raw_str('Pattern'),
			ArgStruct.scalar_int('Bitcount')]

		def __init__(self):
			StructBase.__init__(self, self)
			self.Pattern: str = None
			self.Bitcount: int = None




	def get(self, userIx=repcap.UserIx.Default) -> PatternStruct:
		"""SCPI: [SOURce<HW>]:BB:EVDO:USER<ST>:DATA:PATTern \n
		Snippet: value: PatternStruct = driver.source.bb.evdo.user.data.pattern.get(userIx = repcap.UserIx.Default) \n
		Sets the data pattern for the data portion of the packets sent to the user. The most significant bit (MSB) of this value
		is the MSB of the packet and the word is repeated to fill all space within the packet. \n
			:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
			:return: structure: for return value, see the help for PatternStruct structure arguments."""
		userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
		return self._core.io.query_struct(f'SOURce<HwInstance>:BB:EVDO:USER{userIx_cmd_val}:DATA:PATTern?', self.__class__.PatternStruct())