Source code for RsSmw.Implementations.Source.Bb.Ofdm.Trigger.External

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection

[docs]class ExternalCls:
	"""External commands group definition. 5 total commands, 1 Subgroups, 4 group commands"""

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

	@property
	def synchronize(self):
		"""synchronize commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_synchronize'):
			from .Synchronize import SynchronizeCls
			self._synchronize = SynchronizeCls(self._core, self._cmd_group)
		return self._synchronize


[docs]	def get_rdelay(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:EXTernal:RDELay \n
		Snippet: value: float = driver.source.bb.ofdm.trigger.external.get_rdelay() \n
		Queries the time (in seconds) an external trigger event is delayed for. \n
			:return: res_ext_delay_sec: float Range: 0 to 688
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:RDELay?')
		return Conversions.str_to_float(response)



[docs]	def get_tdelay(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:EXTernal:TDELay \n
		Snippet: value: float = driver.source.bb.ofdm.trigger.external.get_tdelay() \n
		Specifies the trigger delay for external triggering. The value affects all external trigger signals. \n
			:return: trig_ext_time_del: float Range: 0 to 688, Unit: s
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:TDELay?')
		return Conversions.str_to_float(response)



[docs]	def set_tdelay(self, trig_ext_time_del: float) -> None:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:EXTernal:TDELay \n
		Snippet: driver.source.bb.ofdm.trigger.external.set_tdelay(trig_ext_time_del = 1.0) \n
		Specifies the trigger delay for external triggering. The value affects all external trigger signals. \n
			:param trig_ext_time_del: float Range: 0 to 688, Unit: s
		"""
		param = Conversions.decimal_value_to_str(trig_ext_time_del)
		self._core.io.write(f'SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:TDELay {param}')



[docs]	def get_delay(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:[EXTernal]:DELay \n
		Snippet: value: float = driver.source.bb.ofdm.trigger.external.get_delay() \n
		Specifies the trigger delay. \n
			:return: trig_ext_delay: float Range: 0 to 2147483647
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:DELay?')
		return Conversions.str_to_float(response)



[docs]	def set_delay(self, trig_ext_delay: float) -> None:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:[EXTernal]:DELay \n
		Snippet: driver.source.bb.ofdm.trigger.external.set_delay(trig_ext_delay = 1.0) \n
		Specifies the trigger delay. \n
			:param trig_ext_delay: float Range: 0 to 2147483647
		"""
		param = Conversions.decimal_value_to_str(trig_ext_delay)
		self._core.io.write(f'SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:DELay {param}')



[docs]	def get_inhibit(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:[EXTernal]:INHibit \n
		Snippet: value: int = driver.source.bb.ofdm.trigger.external.get_inhibit() \n
		Specifies the number of samples by which a restart is to be inhibited following an external trigger event. \n
			:return: trig_ext_inhibit: integer Range: 0 to dynamic
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:INHibit?')
		return Conversions.str_to_int(response)



[docs]	def set_inhibit(self, trig_ext_inhibit: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:OFDM:TRIGger:[EXTernal]:INHibit \n
		Snippet: driver.source.bb.ofdm.trigger.external.set_inhibit(trig_ext_inhibit = 1) \n
		Specifies the number of samples by which a restart is to be inhibited following an external trigger event. \n
			:param trig_ext_inhibit: integer Range: 0 to dynamic
		"""
		param = Conversions.decimal_value_to_str(trig_ext_inhibit)
		self._core.io.write(f'SOURce<HwInstance>:BB:OFDM:TRIGger:EXTernal:INHibit {param}')


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