Source code for RsFsw.Implementations.Applications.K10x_Lte.Sense.Espectrum.Range.Insert

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class InsertCls:
	"""Insert commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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

	def set(self, mode: enums.TimeOrder, subBlock=repcap.SubBlock.Default, rangePy=repcap.RangePy.Default) -> None:
		"""SCPI: [SENSe]:ESPectrum<sb>:RANGe<ri>:INSert \n
		Snippet: driver.applications.k10Xlte.sense.espectrum.range.insert.set(mode = enums.TimeOrder.AFTer, subBlock = repcap.SubBlock.Default, rangePy = repcap.RangePy.Default) \n
		Inserts a new SEM range and updates the range numbers accordingly. \n
			:param mode: AFTer | BEFore AFTer Inserts a range after the selected range. BEFore Inserts a range before the selected range.
			:param subBlock: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Espectrum')
			:param rangePy: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Range')
		"""
		param = Conversions.enum_scalar_to_str(mode, enums.TimeOrder)
		subBlock_cmd_val = self._cmd_group.get_repcap_cmd_value(subBlock, repcap.SubBlock)
		rangePy_cmd_val = self._cmd_group.get_repcap_cmd_value(rangePy, repcap.RangePy)
		self._core.io.write(f'SENSe:ESPectrum{subBlock_cmd_val}:RANGe{rangePy_cmd_val}:INSert {param}')

	# noinspection PyTypeChecker
	def get(self, subBlock=repcap.SubBlock.Default, rangePy=repcap.RangePy.Default) -> enums.TimeOrder:
		"""SCPI: [SENSe]:ESPectrum<sb>:RANGe<ri>:INSert \n
		Snippet: value: enums.TimeOrder = driver.applications.k10Xlte.sense.espectrum.range.insert.get(subBlock = repcap.SubBlock.Default, rangePy = repcap.RangePy.Default) \n
		Inserts a new SEM range and updates the range numbers accordingly. \n
			:param subBlock: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Espectrum')
			:param rangePy: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Range')
			:return: mode: AFTer | BEFore AFTer Inserts a range after the selected range. BEFore Inserts a range before the selected range."""
		subBlock_cmd_val = self._cmd_group.get_repcap_cmd_value(subBlock, repcap.SubBlock)
		rangePy_cmd_val = self._cmd_group.get_repcap_cmd_value(rangePy, repcap.RangePy)
		response = self._core.io.query_str(f'SENSe:ESPectrum{subBlock_cmd_val}:RANGe{rangePy_cmd_val}:INSert?')
		return Conversions.str_to_scalar_enum(response, enums.TimeOrder)