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:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pattern", core, parent)
[docs]
def set(self, pattern: str, bitcount: int, mobileStation=repcap.MobileStation.Default) -> None:
"""
``[SOURce<HW>]:BB:W3GPp:MSTation<ST>:DPCCh:FBI:PATTern`` \n
Snippet: ``driver.source.bb.w3Gpp.mstation.dpcch.fbi.pattern.set(pattern = rawAbc, bitcount = 1, mobileStation = repcap.MobileStation.Default)`` \n
The command determines the bit pattern when the PATTern data source is selected for the FBI field.
:param pattern: numeric The first parameter determines the bit pattern (choice of hexadecimal, octal or binary notation) , the second specifies the number of bits to use.
:param bitcount: integer Range: 1 to 32
:param mobileStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mstation')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('pattern', pattern, DataType.RawString), ArgSingle('bitcount', bitcount, DataType.Integer))
mobileStation_cmd_val = self._cmd_group.get_repcap_cmd_value(mobileStation, repcap.MobileStation)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:MSTation{mobileStation_cmd_val}:DPCCh:FBI:PATTern {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
class PatternStruct(StructBase):
"""
Response structure. Fields: \n
- 1 Pattern: str: numeric The first parameter determines the bit pattern (choice of hexadecimal, octal or binary notation) , the second specifies the number of bits to use.
- 2 Bitcount: int: integer Range: 1 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
[docs]
def get(self, mobileStation=repcap.MobileStation.Default) -> PatternStruct:
"""
``[SOURce<HW>]:BB:W3GPp:MSTation<ST>:DPCCh:FBI:PATTern`` \n
Snippet: ``value: PatternStruct = driver.source.bb.w3Gpp.mstation.dpcch.fbi.pattern.get(mobileStation = repcap.MobileStation.Default)`` \n
The command determines the bit pattern when the PATTern data source is selected for the FBI field.
:param mobileStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mstation')
:return: structure: for return value, see the help for PatternStruct structure arguments.
"""
mobileStation_cmd_val = self._cmd_group.get_repcap_cmd_value(mobileStation, repcap.MobileStation)
return self._core.io.query_struct(f'SOURce<HwInstance>:BB:W3GPp:MSTation{mobileStation_cmd_val}:DPCCh:FBI:PATTern?', self.__class__.PatternStruct())