Source code for RsSmbv.Implementations.Source.Bb.W3Gpp.Trigger

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class TriggerCls:
	"""Trigger commands group definition. 18 total commands, 5 Subgroups, 5 group commands"""

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

	@property
	def arm(self):
		"""arm commands group. 1 Sub-classes, 0 commands."""
		if not hasattr(self, '_arm'):
			from .Arm import ArmCls
			self._arm = ArmCls(self._core, self._cmd_group)
		return self._arm

	@property
	def execute(self):
		"""execute commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_execute'):
			from .Execute import ExecuteCls
			self._execute = ExecuteCls(self._core, self._cmd_group)
		return self._execute

	@property
	def external(self):
		"""external commands group. 1 Sub-classes, 2 commands."""
		if not hasattr(self, '_external'):
			from .External import ExternalCls
			self._external = ExternalCls(self._core, self._cmd_group)
		return self._external

	@property
	def output(self):
		"""output commands group. 5 Sub-classes, 0 commands."""
		if not hasattr(self, '_output'):
			from .Output import OutputCls
			self._output = OutputCls(self._core, self._cmd_group)
		return self._output

	@property
	def time(self):
		"""time commands group. 2 Sub-classes, 1 commands."""
		if not hasattr(self, '_time'):
			from .Time import TimeCls
			self._time = TimeCls(self._core, self._cmd_group)
		return self._time

	# noinspection PyTypeChecker
[docs]	def get_rmode(self) -> enums.TrigRunMode:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:RMODe \n
		Snippet: value: enums.TrigRunMode = driver.source.bb.w3Gpp.trigger.get_rmode() \n
		Queries the signal generation status. \n
			:return: rmode: STOP| RUN
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:TRIGger:RMODe?')
		return Conversions.str_to_scalar_enum(response, enums.TrigRunMode)

[docs]	def get_slength(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:SLENgth \n
		Snippet: value: int = driver.source.bb.w3Gpp.trigger.get_slength() \n
		Defines the length of the signal sequence that is output in the SINGle trigger mode. \n
			:return: slength: integer Range: 1 to 4293120000
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:TRIGger:SLENgth?')
		return Conversions.str_to_int(response)

[docs]	def set_slength(self, slength: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:SLENgth \n
		Snippet: driver.source.bb.w3Gpp.trigger.set_slength(slength = 1) \n
		Defines the length of the signal sequence that is output in the SINGle trigger mode. \n
			:param slength: integer Range: 1 to 4293120000
		"""
		param = Conversions.decimal_value_to_str(slength)
		self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:TRIGger:SLENgth {param}')

	# noinspection PyTypeChecker
[docs]	def get_sl_unit(self) -> enums.UnitSlW3Gpp:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:SLUNit \n
		Snippet: value: enums.UnitSlW3Gpp = driver.source.bb.w3Gpp.trigger.get_sl_unit() \n
		Defines the unit for the entry of the signal sequence length. \n
			:return: sl_unit: CHIP| FRAMe| SLOT| SEQuence
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:TRIGger:SLUNit?')
		return Conversions.str_to_scalar_enum(response, enums.UnitSlW3Gpp)

[docs]	def set_sl_unit(self, sl_unit: enums.UnitSlW3Gpp) -> None:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:SLUNit \n
		Snippet: driver.source.bb.w3Gpp.trigger.set_sl_unit(sl_unit = enums.UnitSlW3Gpp.CHIP) \n
		Defines the unit for the entry of the signal sequence length. \n
			:param sl_unit: CHIP| FRAMe| SLOT| SEQuence
		"""
		param = Conversions.enum_scalar_to_str(sl_unit, enums.UnitSlW3Gpp)
		self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:TRIGger:SLUNit {param}')

	# noinspection PyTypeChecker
[docs]	def get_source(self) -> enums.TrigSour:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:SOURce \n
		Snippet: value: enums.TrigSour = driver.source.bb.w3Gpp.trigger.get_source() \n
			INTRO_CMD_HELP: Selects the trigger signal source and determines the way the triggering is executed. Provided are: \n
			- Internal triggering by a command (INTernal)
			- External trigger signal via one of the User x connectors EGT1: External global trigger
			- In primary-secondary instrument mode, the external baseband synchronization signal (BBSY)
			- EXTernal: Setting only Provided only for backward compatibility with other Rohde & Schwarz signal generators. The R&S SMBV100B accepts this value and maps it automatically as follows: EXTernal = EGT1 \n
			:return: source: INTernal| EGT1| EXTernal| BBSY
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:TRIGger:SOURce?')
		return Conversions.str_to_scalar_enum(response, enums.TrigSour)

[docs]	def set_source(self, source: enums.TrigSour) -> None:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:TRIGger:SOURce \n
		Snippet: driver.source.bb.w3Gpp.trigger.set_source(source = enums.TrigSour.BBSY) \n
			INTRO_CMD_HELP: Selects the trigger signal source and determines the way the triggering is executed. Provided are: \n
			- Internal triggering by a command (INTernal)
			- External trigger signal via one of the User x connectors EGT1: External global trigger
			- In primary-secondary instrument mode, the external baseband synchronization signal (BBSY)
			- EXTernal: Setting only Provided only for backward compatibility with other Rohde & Schwarz signal generators. The R&S SMBV100B accepts this value and maps it automatically as follows: EXTernal = EGT1 \n
			:param source: INTernal| EGT1| EXTernal| BBSY
		"""
		param = Conversions.enum_scalar_to_str(source, enums.TrigSour)
		self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:TRIGger:SOURce {param}')

	# noinspection PyTypeChecker
[docs]	def get_sequence(self) -> enums.DmTrigMode:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:[TRIGger]:SEQuence \n
		Snippet: value: enums.DmTrigMode = driver.source.bb.w3Gpp.trigger.get_sequence() \n
			INTRO_CMD_HELP: Selects the trigger mode: \n
			- AUTO = auto
			- RETRigger = retrigger
			- AAUTo = armed auto
			- ARETrigger = armed retrigger
			- SINGle = single \n
			:return: sequence: AUTO| RETRigger| AAUTo| ARETrigger| SINGle
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:TRIGger:SEQuence?')
		return Conversions.str_to_scalar_enum(response, enums.DmTrigMode)

[docs]	def set_sequence(self, sequence: enums.DmTrigMode) -> None:
		"""SCPI: [SOURce<HW>]:BB:W3GPp:[TRIGger]:SEQuence \n
		Snippet: driver.source.bb.w3Gpp.trigger.set_sequence(sequence = enums.DmTrigMode.AAUTo) \n
			INTRO_CMD_HELP: Selects the trigger mode: \n
			- AUTO = auto
			- RETRigger = retrigger
			- AAUTo = armed auto
			- ARETrigger = armed retrigger
			- SINGle = single \n
			:param sequence: AUTO| RETRigger| AAUTo| ARETrigger| SINGle
		"""
		param = Conversions.enum_scalar_to_str(sequence, enums.DmTrigMode)
		self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:TRIGger:SEQuence {param}')

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