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

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection


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



	def get_delay(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:DM:TRIGger:[EXTernal]:DELay \n
		Snippet: value: float = driver.source.bb.dm.trigger.external.get_delay() \n
		Sets the trigger delay in symbols. Maximum trigger delay and trigger inhibit values depend on the installed options. See
		'To set delay and inhibit values'. \n
			:return: delay: float Range: 0 to depends on the symbol rate, Unit: symbol E.g. 0 to 2147483647 symbols (R&S SMW-B10)
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DM:TRIGger:EXTernal:DELay?')
		return Conversions.str_to_float(response)




	def set_delay(self, delay: float) -> None:
		"""SCPI: [SOURce<HW>]:BB:DM:TRIGger:[EXTernal]:DELay \n
		Snippet: driver.source.bb.dm.trigger.external.set_delay(delay = 1.0) \n
		Sets the trigger delay in symbols. Maximum trigger delay and trigger inhibit values depend on the installed options. See
		'To set delay and inhibit values'. \n
			:param delay: float Range: 0 to depends on the symbol rate, Unit: symbol E.g. 0 to 2147483647 symbols (R&S SMW-B10)
		"""
		param = Conversions.decimal_value_to_str(delay)
		self._core.io.write(f'SOURce<HwInstance>:BB:DM:TRIGger:EXTernal:DELay {param}')




	def get_inhibit(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:DM:TRIGger:[EXTernal]:INHibit \n
		Snippet: value: int = driver.source.bb.dm.trigger.external.get_inhibit() \n
		Sets the number of symbols that inhibit a restart of the signal generation. Maximum trigger delay and trigger inhibit
		values depend on the installed options. See 'To set delay and inhibit values'. \n
			:return: inhibit: integer Range: 0 to 21.47 * (symbol rate) , Unit: symbol E.g. 0 to 2147483647 symbols (R&S SMW-B10)
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DM:TRIGger:EXTernal:INHibit?')
		return Conversions.str_to_int(response)




	def set_inhibit(self, inhibit: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:DM:TRIGger:[EXTernal]:INHibit \n
		Snippet: driver.source.bb.dm.trigger.external.set_inhibit(inhibit = 1) \n
		Sets the number of symbols that inhibit a restart of the signal generation. Maximum trigger delay and trigger inhibit
		values depend on the installed options. See 'To set delay and inhibit values'. \n
			:param inhibit: integer Range: 0 to 21.47 * (symbol rate) , Unit: symbol E.g. 0 to 2147483647 symbols (R&S SMW-B10)
		"""
		param = Conversions.decimal_value_to_str(inhibit)
		self._core.io.write(f'SOURce<HwInstance>:BB:DM:TRIGger:EXTernal:INHibit {param}')




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




	def get_tdelay(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:DM:TRIGger:[EXTernal]:TDELay \n
		Snippet: value: float = driver.source.bb.dm.trigger.external.get_tdelay() \n
		Sets the trigger delay for external triggering. The value affects all external trigger signals. Maximum trigger delay and
		trigger inhibit values depend on the installed options. See 'To set delay and inhibit values'. \n
			:return: ext_time_delay: float Range: 0 to 7929.170398682, Unit: s
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DM:TRIGger:EXTernal:TDELay?')
		return Conversions.str_to_float(response)




	def set_tdelay(self, ext_time_delay: float) -> None:
		"""SCPI: [SOURce<HW>]:BB:DM:TRIGger:[EXTernal]:TDELay \n
		Snippet: driver.source.bb.dm.trigger.external.set_tdelay(ext_time_delay = 1.0) \n
		Sets the trigger delay for external triggering. The value affects all external trigger signals. Maximum trigger delay and
		trigger inhibit values depend on the installed options. See 'To set delay and inhibit values'. \n
			:param ext_time_delay: float Range: 0 to 7929.170398682, Unit: s
		"""
		param = Conversions.decimal_value_to_str(ext_time_delay)
		self._core.io.write(f'SOURce<HwInstance>:BB:DM:TRIGger:EXTernal:TDELay {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