Source code for RsSmw.Implementations.Source.Bb.V5G.Downlink.Prss

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class PrssCls:
	"""Prss commands group definition. 8 total commands, 1 Subgroups, 7 group commands"""

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

	@property
	def tprs(self):
		"""tprs commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_tprs'):
			from .Tprs import TprsCls
			self._tprs = TprsCls(self._core, self._cmd_group)
		return self._tprs

	# noinspection PyTypeChecker
[docs]	def get_bw(self) -> enums.EutraCaChannelBandwidth:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:BW \n
		Snippet: value: enums.EutraCaChannelBandwidth = driver.source.bb.v5G.downlink.prss.get_bw() \n
		No command help available \n
			:return: prs_bandwidth: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:BW?')
		return Conversions.str_to_scalar_enum(response, enums.EutraCaChannelBandwidth)

[docs]	def set_bw(self, prs_bandwidth: enums.EutraCaChannelBandwidth) -> None:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:BW \n
		Snippet: driver.source.bb.v5G.downlink.prss.set_bw(prs_bandwidth = enums.EutraCaChannelBandwidth.BW1_40) \n
		No command help available \n
			:param prs_bandwidth: No help available
		"""
		param = Conversions.enum_scalar_to_str(prs_bandwidth, enums.EutraCaChannelBandwidth)
		self._core.io.write(f'SOURce<HwInstance>:BB:V5G:DL:PRSS:BW {param}')

[docs]	def get_ci(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:CI \n
		Snippet: value: int = driver.source.bb.v5G.downlink.prss.get_ci() \n
		No command help available \n
			:return: conf_idx: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:CI?')
		return Conversions.str_to_int(response)

[docs]	def set_ci(self, conf_idx: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:CI \n
		Snippet: driver.source.bb.v5G.downlink.prss.set_ci(conf_idx = 1) \n
		No command help available \n
			:param conf_idx: No help available
		"""
		param = Conversions.decimal_value_to_str(conf_idx)
		self._core.io.write(f'SOURce<HwInstance>:BB:V5G:DL:PRSS:CI {param}')

[docs]	def get_dprs(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:DPRS \n
		Snippet: value: int = driver.source.bb.v5G.downlink.prss.get_dprs() \n
		No command help available \n
			:return: delta_prs: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:DPRS?')
		return Conversions.str_to_int(response)

[docs]	def get_mi_pattern(self) -> str:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:MIPattern \n
		Snippet: value: str = driver.source.bb.v5G.downlink.prss.get_mi_pattern() \n
		No command help available \n
			:return: prs_muting_info: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:MIPattern?')
		return trim_str_response(response)

[docs]	def set_mi_pattern(self, prs_muting_info: str) -> None:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:MIPattern \n
		Snippet: driver.source.bb.v5G.downlink.prss.set_mi_pattern(prs_muting_info = rawAbc) \n
		No command help available \n
			:param prs_muting_info: No help available
		"""
		param = Conversions.value_to_str(prs_muting_info)
		self._core.io.write(f'SOURce<HwInstance>:BB:V5G:DL:PRSS:MIPattern {param}')

	# noinspection PyTypeChecker
[docs]	def get_nprs(self) -> enums.Nprs:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:NPRS \n
		Snippet: value: enums.Nprs = driver.source.bb.v5G.downlink.prss.get_nprs() \n
		No command help available \n
			:return: number_prs: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:NPRS?')
		return Conversions.str_to_scalar_enum(response, enums.Nprs)

[docs]	def set_nprs(self, number_prs: enums.Nprs) -> None:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:NPRS \n
		Snippet: driver.source.bb.v5G.downlink.prss.set_nprs(number_prs = enums.Nprs._1) \n
		No command help available \n
			:param number_prs: No help available
		"""
		param = Conversions.enum_scalar_to_str(number_prs, enums.Nprs)
		self._core.io.write(f'SOURce<HwInstance>:BB:V5G:DL:PRSS:NPRS {param}')

[docs]	def get_pow(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:POW \n
		Snippet: value: float = driver.source.bb.v5G.downlink.prss.get_pow() \n
		No command help available \n
			:return: prs_power: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:POW?')
		return Conversions.str_to_float(response)

[docs]	def set_pow(self, prs_power: float) -> None:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:POW \n
		Snippet: driver.source.bb.v5G.downlink.prss.set_pow(prs_power = 1.0) \n
		No command help available \n
			:param prs_power: No help available
		"""
		param = Conversions.decimal_value_to_str(prs_power)
		self._core.io.write(f'SOURce<HwInstance>:BB:V5G:DL:PRSS:POW {param}')

[docs]	def get_state(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:STATe \n
		Snippet: value: bool = driver.source.bb.v5G.downlink.prss.get_state() \n
		No command help available \n
			:return: prs_state: No help available
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:V5G:DL:PRSS:STATe?')
		return Conversions.str_to_bool(response)

[docs]	def set_state(self, prs_state: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:V5G:DL:PRSS:STATe \n
		Snippet: driver.source.bb.v5G.downlink.prss.set_state(prs_state = False) \n
		No command help available \n
			:param prs_state: No help available
		"""
		param = Conversions.bool_to_str(prs_state)
		self._core.io.write(f'SOURce<HwInstance>:BB:V5G:DL:PRSS:STATe {param}')

	def clone(self) -> 'PrssCls':
		"""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 = PrssCls(self._core, self._cmd_group.parent)
		self._cmd_group.synchronize_repcaps(new_group)
		return new_group