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 .........Internal.RepeatedCapability import RepeatedCapability
from ......... import enums
from ......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class CbandwidthCls:
"""Cbandwidth commands group definition. 1 total commands, 0 Subgroups, 1 group commands
Repeated Capability: ChannelBw, default value after init: ChannelBw.Bw5"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cbandwidth", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_channelBw_get', 'repcap_channelBw_set', repcap.ChannelBw.Bw5)
def repcap_channelBw_set(self, channelBw: repcap.ChannelBw) -> None:
"""Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to ChannelBw.Default
Default value after init: ChannelBw.Bw5"""
self._cmd_group.set_repcap_enum_value(channelBw)
def repcap_channelBw_get(self) -> repcap.ChannelBw:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
[docs]
def set(self, enable: bool, frequency_start: float, frequency_end: float, level: float, rbw: enums.RbwB, area=repcap.Area.Default, addTable=repcap.AddTable.Default, channelBw=repcap.ChannelBw.Default) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:MEValuation:LIMit:SEMask:AREA<area>:ADDitional<table>:CBANdwidth<bw> \n
Snippet: driver.configure.nrSubMeas.multiEval.limit.seMask.area.additional.cbandwidth.set(enable = False, frequency_start = 1.0, frequency_end = 1.0, level = 1.0, rbw = enums.RbwB.K030, area = repcap.Area.Default, addTable = repcap.AddTable.Default, channelBw = repcap.ChannelBw.Default) \n
Defines additional requirements for the emission mask area number <area> (for NR SA without CA) . The activation state,
the area borders, an upper limit and the resolution bandwidth must be specified. The emission mask applies to the channel
bandwidth <bw>. Several tables of additional requirements are available. \n
:param enable: OFF: Disables the check of these requirements. ON: Enables the check of these requirements.
:param frequency_start: Stop frequency of the area, relative to the edges of the channel bandwidth.
:param frequency_end: No help available
:param level: Upper limit for the area
:param rbw: Resolution bandwidth to be used for the area. Only a subset of the values is allowed, depending on table and bw. K030: 30 kHz K100: 100 kHz K400: 400 kHz M1: 1 MHz PC1: 1 % of channel bandwidth PC2: 2 % of channel bandwidth
:param area: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Area')
:param addTable: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Additional')
:param channelBw: optional repeated capability selector. Default value: Bw5 (settable in the interface 'Cbandwidth')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('enable', enable, DataType.Boolean), ArgSingle('frequency_start', frequency_start, DataType.Float), ArgSingle('frequency_end', frequency_end, DataType.Float), ArgSingle('level', level, DataType.Float), ArgSingle('rbw', rbw, DataType.Enum, enums.RbwB))
area_cmd_val = self._cmd_group.get_repcap_cmd_value(area, repcap.Area)
addTable_cmd_val = self._cmd_group.get_repcap_cmd_value(addTable, repcap.AddTable)
channelBw_cmd_val = self._cmd_group.get_repcap_cmd_value(channelBw, repcap.ChannelBw)
self._core.io.write(f'CONFigure:NRSub:MEASurement<Instance>:MEValuation:LIMit:SEMask:AREA{area_cmd_val}:ADDitional{addTable_cmd_val}:CBANdwidth{channelBw_cmd_val} {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
class CbandwidthStruct(StructBase):
"""Response structure. Fields: \n
- Enable: bool: OFF: Disables the check of these requirements. ON: Enables the check of these requirements.
- Frequency_Start: float: Stop frequency of the area, relative to the edges of the channel bandwidth.
- Frequency_End: float: No parameter help available
- Level: float: Upper limit for the area
- Rbw: enums.RbwB: Resolution bandwidth to be used for the area. Only a subset of the values is allowed, depending on table and bw. K030: 30 kHz K100: 100 kHz K400: 400 kHz M1: 1 MHz PC1: 1 % of channel bandwidth PC2: 2 % of channel bandwidth"""
__meta_args_list = [
ArgStruct.scalar_bool('Enable'),
ArgStruct.scalar_float('Frequency_Start'),
ArgStruct.scalar_float('Frequency_End'),
ArgStruct.scalar_float('Level'),
ArgStruct.scalar_enum('Rbw', enums.RbwB)]
def __init__(self):
StructBase.__init__(self, self)
self.Enable: bool = None
self.Frequency_Start: float = None
self.Frequency_End: float = None
self.Level: float = None
self.Rbw: enums.RbwB = None
[docs]
def get(self, area=repcap.Area.Default, addTable=repcap.AddTable.Default, channelBw=repcap.ChannelBw.Default) -> CbandwidthStruct:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:MEValuation:LIMit:SEMask:AREA<area>:ADDitional<table>:CBANdwidth<bw> \n
Snippet: value: CbandwidthStruct = driver.configure.nrSubMeas.multiEval.limit.seMask.area.additional.cbandwidth.get(area = repcap.Area.Default, addTable = repcap.AddTable.Default, channelBw = repcap.ChannelBw.Default) \n
Defines additional requirements for the emission mask area number <area> (for NR SA without CA) . The activation state,
the area borders, an upper limit and the resolution bandwidth must be specified. The emission mask applies to the channel
bandwidth <bw>. Several tables of additional requirements are available. \n
:param area: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Area')
:param addTable: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Additional')
:param channelBw: optional repeated capability selector. Default value: Bw5 (settable in the interface 'Cbandwidth')
:return: structure: for return value, see the help for CbandwidthStruct structure arguments."""
area_cmd_val = self._cmd_group.get_repcap_cmd_value(area, repcap.Area)
addTable_cmd_val = self._cmd_group.get_repcap_cmd_value(addTable, repcap.AddTable)
channelBw_cmd_val = self._cmd_group.get_repcap_cmd_value(channelBw, repcap.ChannelBw)
return self._core.io.query_struct(f'CONFigure:NRSub:MEASurement<Instance>:MEValuation:LIMit:SEMask:AREA{area_cmd_val}:ADDitional{addTable_cmd_val}:CBANdwidth{channelBw_cmd_val}?', self.__class__.CbandwidthStruct())
def clone(self) -> 'CbandwidthCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = CbandwidthCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group