Source code for RsSmbv.Implementations.Source.Bb.Vor

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class VorCls:
	"""
	| Commands in total: 45
	| Subgroups: 10
	| Direct child commands: 3
	"""

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

	@property
	def clock(self):
		"""
		| Commands in total: 3
		| Subgroups: 0
		| Direct child commands: 3
		"""
		if not hasattr(self, '_clock'):
			from .Clock import ClockCls
			self._clock = ClockCls(self._core, self._cmd_group)
		return self._clock

	@property
	def frequency(self):
		"""
		| Commands in total: 3
		| Subgroups: 0
		| Direct child commands: 3
		"""
		if not hasattr(self, '_frequency'):
			from .Frequency import FrequencyCls
			self._frequency = FrequencyCls(self._core, self._cmd_group)
		return self._frequency

	@property
	def setting(self):
		"""
		| Commands in total: 4
		| Subgroups: 0
		| Direct child commands: 4
		"""
		if not hasattr(self, '_setting'):
			from .Setting import SettingCls
			self._setting = SettingCls(self._core, self._cmd_group)
		return self._setting

	@property
	def trigger(self):
		"""
		| Commands in total: 12
		| Subgroups: 4
		| Direct child commands: 4
		"""
		if not hasattr(self, '_trigger'):
			from .Trigger import TriggerCls
			self._trigger = TriggerCls(self._core, self._cmd_group)
		return self._trigger

	@property
	def comid(self):
		"""
		| Commands in total: 12
		| Subgroups: 1
		| Direct child commands: 10
		"""
		if not hasattr(self, '_comid'):
			from .Comid import ComidCls
			self._comid = ComidCls(self._core, self._cmd_group)
		return self._comid

	@property
	def icao(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_icao'):
			from .Icao import IcaoCls
			self._icao = IcaoCls(self._core, self._cmd_group)
		return self._icao

	@property
	def reference(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_reference'):
			from .Reference import ReferenceCls
			self._reference = ReferenceCls(self._core, self._cmd_group)
		return self._reference

	@property
	def subcarrier(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_subcarrier'):
			from .Subcarrier import SubcarrierCls
			self._subcarrier = SubcarrierCls(self._core, self._cmd_group)
		return self._subcarrier

	@property
	def var(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_var'):
			from .Var import VarCls
			self._var = VarCls(self._core, self._cmd_group)
		return self._var

	@property
	def bangle(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_bangle'):
			from .Bangle import BangleCls
			self._bangle = BangleCls(self._core, self._cmd_group)
		return self._bangle

[docs] def preset(self) -> None: """ ``[SOURce<HW>]:BB:VOR:PRESet`` \n Snippet: ``driver.source.bb.vor.preset()`` \n Sets the parameters of the digital standard to their default values (``*RST`` values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:VOR | ILS | DME:STATe. """ self._core.io.write(f'SOURce<HwInstance>:BB:VOR:PRESet')
[docs] def preset_with_opc(self, opc_timeout_ms: int = -1) -> None: """ ``[SOURce<HW>]:BB:VOR:PRESet`` \n Snippet: ``driver.source.bb.vor.preset_with_opc()`` \n Sets the parameters of the digital standard to their default values (``*RST`` values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:VOR | ILS | DME:STATe. Same as preset, but waits for the operation to complete before continuing further. Use the RsSmbv.utilities.opc_timeout_set() to set the timeout value. :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:VOR:PRESet', opc_timeout_ms)
[docs] def get_state(self) -> bool: """ ``[SOURce<HW>]:BB:VOR:STATe`` \n Snippet: ``value: bool = driver.source.bb.vor.get_state()`` \n Activates/deactivates the avionic standard. :return: state: 1 | ON | 0| OFF """ response = self._core.io.query_str('SOURce<HwInstance>:BB:VOR:STATe?') return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None: """ ``[SOURce<HW>]:BB:VOR:STATe`` \n Snippet: ``driver.source.bb.vor.set_state(state = False)`` \n Activates/deactivates the avionic standard. :param state: 1 | ON | 0| OFF """ param = Conversions.bool_to_str(state) self._core.io.write(f'SOURce<HwInstance>:BB:VOR:STATe {param}')
# noinspection PyTypeChecker
[docs] def get_mode(self) -> enums.AvionicVorMode: """ ``[SOURce<HW>]:[BB]:VOR:MODE`` \n Snippet: ``value: enums.AvionicVorMode = driver.source.bb.vor.get_mode()`` \n Sets the operating mode for the VOR modulation signal. :return: mode: NORM | VAR | SUBCarrier | FMSubcarrier NORM VOR modulation is active. VAR Amplitude modulation of the output signal with the variable signal component (30Hz signal content) of the VOR signal. The modulation depth of the 30 Hz signal can be set with method ``RsSmbv.source.bb.vor.var.depth()`` . SUBCarrier Amplitude modulation of the output signal with the unmodulated FM carrier (9960Hz) of the VOR signal. The modulation depth of the 30 Hz signal can be set with method ``RsSmbv.source.bb.vor.subcarrier.depth()`` . FMSubcarrier Amplitude modulation of the output signal with the frequency modulated FM carrier (9960Hz) of the VOR signal. The modulation depth of the 30 Hz signal can be set with method ``RsSmbv.source.bb.vor.subcarrier.depth()`` . The frequency deviation can be set with method ``RsSmbv.source.bb.vor.reference.deviation()`` . """ response = self._core.io.query_str('SOURce<HwInstance>:BB:VOR:MODE?') return Conversions.str_to_scalar_enum(response, enums.AvionicVorMode)
[docs] def set_mode(self, mode: enums.AvionicVorMode) -> None: """ ``[SOURce<HW>]:[BB]:VOR:MODE`` \n Snippet: ``driver.source.bb.vor.set_mode(mode = enums.AvionicVorMode.FMSubcarrier)`` \n Sets the operating mode for the VOR modulation signal. :param mode: NORM | VAR | SUBCarrier | FMSubcarrier NORM VOR modulation is active. VAR Amplitude modulation of the output signal with the variable signal component (30Hz signal content) of the VOR signal. The modulation depth of the 30 Hz signal can be set with method ``RsSmbv.source.bb.vor.var.depth()`` . SUBCarrier Amplitude modulation of the output signal with the unmodulated FM carrier (9960Hz) of the VOR signal. The modulation depth of the 30 Hz signal can be set with method ``RsSmbv.source.bb.vor.subcarrier.depth()`` . FMSubcarrier Amplitude modulation of the output signal with the frequency modulated FM carrier (9960Hz) of the VOR signal. The modulation depth of the 30 Hz signal can be set with method ``RsSmbv.source.bb.vor.subcarrier.depth()`` . The frequency deviation can be set with method ``RsSmbv.source.bb.vor.reference.deviation()`` . """ param = Conversions.enum_scalar_to_str(mode, enums.AvionicVorMode) self._core.io.write(f'SOURce<HwInstance>:BB:VOR:MODE {param}')
def clone(self) -> 'VorCls': """ 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 = VorCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group