Source code for RsSmw.Implementations.Source.Bb.Nr5G.Qckset.General

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class GeneralCls:
	"""
	| Commands in total: 17
	| Subgroups: 2
	| Direct child commands: 9
	"""

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

	@property
	def es(self):
		"""
		| Commands in total: 7
		| Subgroups: 2
		| Direct child commands: 5
		"""
		if not hasattr(self, '_es'):
			from .Es import EsCls
			self._es = EsCls(self._core, self._cmd_group)
		return self._es

	@property
	def sffm(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_sffm'):
			from .Sffm import SffmCls
			self._sffm = SffmCls(self._core, self._cmd_group)
		return self._sffm

	# noinspection PyTypeChecker
[docs] def get_cardeply(self) -> enums.Nr5GcarDep: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:CARDeply`` \n Snippet: ``value: enums.Nr5GcarDep = driver.source.bb.nr5G.qckset.general.get_cardeply()`` \n Selects one of the frequency ranges, specified for 5G NR transmission. """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:CARDeply?') return Conversions.str_to_scalar_enum(response, enums.Nr5GcarDep)
# noinspection PyTypeChecker
[docs] def get_cbw(self) -> enums.Nr5Gcbw: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:CBW`` \n Snippet: ``value: enums.Nr5Gcbw = driver.source.bb.nr5G.qckset.general.get_cbw()`` \n Selects the bandwidth of the node carrier. :return: qck_set_channel_bw: BW5 | BW10 | BW15 | BW20 | BW25 | BW30 | BW35 | BW40 | BW45 | BW50 | BW60 | BW70 | BW80 | BW90 | BW100 | BW200 | BW400 | BW500 | BW800 | BW1600 | BW2000 | BW4000 | BW8000 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:CBW?') return Conversions.str_to_scalar_enum(response, enums.Nr5Gcbw)
[docs] def get_cct_model(self) -> bool: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:CCTModel`` \n Snippet: ``value: bool = driver.source.bb.nr5G.qckset.general.get_cct_model()`` \n Creates a copy of a component carrier based on a test model configuration. Prerequisites for this command \n - Select a single carrier (method ``RsSmw.source.bb.nr5G.qckset.general.ncarrier()`` ) . - Select a test model (method ``RsSmw.source.bb.nr5G.setting.tmodel.downlink.value()`` / method ``RsSmw.source.bb.nr5G.setting.tmodel.uplink.value()`` ) . """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:CCTModel?') return Conversions.str_to_bool(response)
# noinspection PyTypeChecker
[docs] def get_ch_raster(self) -> enums.AllChannelRaster: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:CHRaster`` \n Snippet: ``value: enums.AllChannelRaster = driver.source.bb.nr5G.qckset.general.get_ch_raster()`` \n Sets the 'Channel Raster' based on the set 'Deployment'. If 'Deployment' is set to 'FR1 <= 3GHz' or 'FR1 > 3GHz' the 'Channel Raster' can be set to 15 kHz or 100 kHz. If 'Deployment' is set to 'FR2-1' the 'Channel Raster' is set to 60 kHz. If 'Deployment' is set to 'FR2-2' the 'Channel Raster' is set to 100 kHz. 'Channel Raster' is not displayed when the 'Number of Carriers' is shown inactive. :return: channel_raster: R15 | R60 | R100 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:CHRaster?') return Conversions.str_to_scalar_enum(response, enums.AllChannelRaster)
[docs] def get_ch_spacing(self) -> int: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:CHSPacing`` \n Snippet: ``value: int = driver.source.bb.nr5G.qckset.general.get_ch_spacing()`` \n Queries or sets the value for the 'Channel Spacing'. It is by default automatically calculated by the set 'Channel Raster' and the set 'Channel Bandwidth'. The value can be manually adjusted, but is recalculated if the 'Channel Raster' or the 'Channel Bandwidth' is adjusted. 'Channel Spacing' is not displayed when the 'Number of Carriers' is shown inactive. In this case, it is used like 'Carrier Spacing' equals 0. :return: channel_spacing: integer Range: 0 to 800E6 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:CHSPacing?') return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs] def get_duplexing(self) -> enums.EutraDuplexMode: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:DUPLexing`` \n Snippet: ``value: enums.EutraDuplexMode = driver.source.bb.nr5G.qckset.general.get_duplexing()`` \n Selects the duplexing mode. :return: qck_set_duplexing: TDD | FDD """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:DUPLexing?') return Conversions.str_to_scalar_enum(response, enums.EutraDuplexMode)
[docs] def get_ecp_state(self) -> bool: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:ECPState`` \n Snippet: ``value: bool = driver.source.bb.nr5G.qckset.general.get_ecp_state()`` \n Show if the extended cyclic prefix is enabled or disabled. :return: qss_cs_ecp_state: 1 | ON | 0| OFF """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:ECPState?') return Conversions.str_to_bool(response)
[docs] def get_ncarrier(self) -> int: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:NCARier`` \n Snippet: ``value: int = driver.source.bb.nr5G.qckset.general.get_ncarrier()`` \n Selects the number of carriers. Needed for carrier aggregation. :return: qck_set_num_carrier: integer Range: 1 to 16 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:NCARier?') return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs] def get_sc_spacing(self) -> enums.QucjSettingsScsAll: """ ``[SOURce<HW>]:BB:NR5G:QCKSet:GENeral:SCSPacing`` \n Snippet: ``value: enums.QucjSettingsScsAll = driver.source.bb.nr5G.qckset.general.get_sc_spacing()`` \n Sets the subcarrier spacing. """ response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:QCKSet:GENeral:SCSPacing?') return Conversions.str_to_scalar_enum(response, enums.QucjSettingsScsAll)
def clone(self) -> 'GeneralCls': """ 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 = GeneralCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group