Source code for RsSmbv.Implementations.Source.Bb.Gnss.AdGeneration.Gps.Svid.State

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection

[docs]class StateCls:
	"""State commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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


[docs]	def set(self, state: bool, satelliteSvid=repcap.SatelliteSvid.Default) -> None:
		"""SCPI: [SOURce<HW>]:BB:GNSS:ADGeneration:GPS:SVID<CH>:STATe \n
		Snippet: driver.source.bb.gnss.adGeneration.gps.svid.state.set(state = False, satelliteSvid = repcap.SatelliteSvid.Default) \n
		Activates satellites so that they are included in the generated assistance data. \n
			:param state: 1| ON| 0| OFF
			:param satelliteSvid: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Svid')
		"""
		param = Conversions.bool_to_str(state)
		satelliteSvid_cmd_val = self._cmd_group.get_repcap_cmd_value(satelliteSvid, repcap.SatelliteSvid)
		self._core.io.write(f'SOURce<HwInstance>:BB:GNSS:ADGeneration:GPS:SVID{satelliteSvid_cmd_val}:STATe {param}')



[docs]	def get(self, satelliteSvid=repcap.SatelliteSvid.Default) -> bool:
		"""SCPI: [SOURce<HW>]:BB:GNSS:ADGeneration:GPS:SVID<CH>:STATe \n
		Snippet: value: bool = driver.source.bb.gnss.adGeneration.gps.svid.state.get(satelliteSvid = repcap.SatelliteSvid.Default) \n
		Activates satellites so that they are included in the generated assistance data. \n
			:param satelliteSvid: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Svid')
			:return: state: 1| ON| 0| OFF"""
		satelliteSvid_cmd_val = self._cmd_group.get_repcap_cmd_value(satelliteSvid, repcap.SatelliteSvid)
		response = self._core.io.query_str(f'SOURce<HwInstance>:BB:GNSS:ADGeneration:GPS:SVID{satelliteSvid_cmd_val}:STATe?')
		return Conversions.str_to_bool(response)