Source code for RsSmw.Implementations.Source.Bb.Evdo

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection


[docs]
class EvdoCls:
	"""Evdo commands group definition. 156 total commands, 13 Subgroups, 8 group commands"""

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

	@property
	def anetwork(self):
		"""anetwork commands group. 3 Sub-classes, 3 commands."""
		if not hasattr(self, '_anetwork'):
			from .Anetwork import AnetworkCls
			self._anetwork = AnetworkCls(self._core, self._cmd_group)
		return self._anetwork

	@property
	def clipping(self):
		"""clipping commands group. 0 Sub-classes, 3 commands."""
		if not hasattr(self, '_clipping'):
			from .Clipping import ClippingCls
			self._clipping = ClippingCls(self._core, self._cmd_group)
		return self._clipping

	@property
	def clock(self):
		"""clock commands group. 0 Sub-classes, 3 commands."""
		if not hasattr(self, '_clock'):
			from .Clock import ClockCls
			self._clock = ClockCls(self._core, self._cmd_group)
		return self._clock

	@property
	def crate(self):
		"""crate commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_crate'):
			from .Crate import CrateCls
			self._crate = CrateCls(self._core, self._cmd_group)
		return self._crate

	@property
	def down(self):
		"""down commands group. 1 Sub-classes, 0 commands."""
		if not hasattr(self, '_down'):
			from .Down import DownCls
			self._down = DownCls(self._core, self._cmd_group)
		return self._down

	@property
	def filterPy(self):
		"""filterPy commands group. 3 Sub-classes, 2 commands."""
		if not hasattr(self, '_filterPy'):
			from .FilterPy import FilterPyCls
			self._filterPy = FilterPyCls(self._core, self._cmd_group)
		return self._filterPy

	@property
	def iqswap(self):
		"""iqswap commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_iqswap'):
			from .Iqswap import IqswapCls
			self._iqswap = IqswapCls(self._core, self._cmd_group)
		return self._iqswap

	@property
	def setting(self):
		"""setting commands group. 0 Sub-classes, 4 commands."""
		if not hasattr(self, '_setting'):
			from .Setting import SettingCls
			self._setting = SettingCls(self._core, self._cmd_group)
		return self._setting

	@property
	def terminal(self):
		"""terminal commands group. 15 Sub-classes, 0 commands."""
		if not hasattr(self, '_terminal'):
			from .Terminal import TerminalCls
			self._terminal = TerminalCls(self._core, self._cmd_group)
		return self._terminal

	@property
	def trigger(self):
		"""trigger commands group. 6 Sub-classes, 5 commands."""
		if not hasattr(self, '_trigger'):
			from .Trigger import TriggerCls
			self._trigger = TriggerCls(self._core, self._cmd_group)
		return self._trigger

	@property
	def up(self):
		"""up commands group. 1 Sub-classes, 0 commands."""
		if not hasattr(self, '_up'):
			from .Up import UpCls
			self._up = UpCls(self._core, self._cmd_group)
		return self._up

	@property
	def user(self):
		"""user commands group. 11 Sub-classes, 0 commands."""
		if not hasattr(self, '_user'):
			from .User import UserCls
			self._user = UserCls(self._core, self._cmd_group)
		return self._user

	@property
	def waveform(self):
		"""waveform commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_waveform'):
			from .Waveform import WaveformCls
			self._waveform = WaveformCls(self._core, self._cmd_group)
		return self._waveform

	# noinspection PyTypeChecker








[docs]
	def get_pn_offset(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EVDO:PNOFfset \n
		Snippet: value: int = driver.source.bb.evdo.get_pn_offset() \n
		Sets the PN Offset of the 1xEV-DO signal. \n
			:return: pn_offset: integer Range: 0 to 511
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EVDO:PNOFfset?')
		return Conversions.str_to_int(response)





[docs]
	def set_pn_offset(self, pn_offset: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:PNOFfset \n
		Snippet: driver.source.bb.evdo.set_pn_offset(pn_offset = 1) \n
		Sets the PN Offset of the 1xEV-DO signal. \n
			:param pn_offset: integer Range: 0 to 511
		"""
		param = Conversions.decimal_value_to_str(pn_offset)
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:PNOFfset {param}')



	# noinspection PyTypeChecker


[docs]
	def get_predefined(self) -> enums.EvdoPredSett:
		"""SCPI: [SOURce<HW>]:BB:EVDO:PREDefined \n
		Snippet: value: enums.EvdoPredSett = driver.source.bb.evdo.get_predefined() \n
		Sets the UL setting of Terminal 1 to one of the predefined configurations. The predefined settings are made according to
		3GPP2 C.S0032-A to allow easy receiver testing.
			Table Header: Parameter / Description \n
			- USER / There are no predefined settings
			- ULS1DR9K6 / UL, Subtype 1, 9.6 kbps.
			- ULS1DR19K2 / UL, Subtype 1, 19.2 kbps.
			- ULS1DR38K4 / UL, Subtype 1, 38.4 kbps.
			- ULS1DR76K8 / UL, Subtype 1, 76.8 kbps.
			- ULS1DR153K6 / UL, Subtype 1, 153.6 kbps.
			- ULS2PS128LL / UL, Subtype 2, 128 bits payload, Low Latency.
			- ULS2PS256HC / UL, Subtype 2, 256 bits payload, High Capacity.
			- ULS2PS256LL / UL, Subtype 2, 256 bits payload, Low Latency.
			- ULS2PS512LL / UL, Subtype 2, 512 bits payload, Low Latency.
			- ULS2PS768LL / UL, Subtype 2, 768 bits payload, Low Latency.
			- ULS2PS1024LL / UL, Subtype 2, 1024 bits payload, Low Latency.
			- ULS2PS1536LL / UL, Subtype 2, 1536 bits payload, Low Latency.
			- ULS2PS2048LL / UL, Subtype 2, 2048 bits payload, Low Latency.
			- ULS2PS3072LL / UL, Subtype 2, 3072 bits payload, Low Latency.
			- ULS2PS4096LL / UL, Subtype 2, 4096 bits payload, Low Latency.
			- ULS2PS6144LL / UL, Subtype 2, 6144 bits payload, Low Latency.
			- ULS2PS8192LL / UL, Subtype 2, 8192 bits payload, Low Latency.
			- ULS2PS12288LL / UL, Subtype 2, 12288 bits payload, Low Latency. \n
			:return: predefined: USER| ULS1DR9K6| ULS1DR19K2| ULS1DR38K4| ULS1DR76K8| ULS1DR153K6| ULS2PS128LL| ULS2PS256HC| ULS2PS256LL| ULS2PS512LL| ULS2PS768LL| ULS2PS1024LL| ULS2PS1536LL| ULS2PS2048LL| ULS2PS3072LL| ULS2PS4096LL| ULS2PS6144LL| ULS2PS8192LL| ULS2PS12288LL
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EVDO:PREDefined?')
		return Conversions.str_to_scalar_enum(response, enums.EvdoPredSett)





[docs]
	def set_predefined(self, predefined: enums.EvdoPredSett) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:PREDefined \n
		Snippet: driver.source.bb.evdo.set_predefined(predefined = enums.EvdoPredSett.ULS1DR153K6) \n
		Sets the UL setting of Terminal 1 to one of the predefined configurations. The predefined settings are made according to
		3GPP2 C.S0032-A to allow easy receiver testing.
			Table Header: Parameter / Description \n
			- USER / There are no predefined settings
			- ULS1DR9K6 / UL, Subtype 1, 9.6 kbps.
			- ULS1DR19K2 / UL, Subtype 1, 19.2 kbps.
			- ULS1DR38K4 / UL, Subtype 1, 38.4 kbps.
			- ULS1DR76K8 / UL, Subtype 1, 76.8 kbps.
			- ULS1DR153K6 / UL, Subtype 1, 153.6 kbps.
			- ULS2PS128LL / UL, Subtype 2, 128 bits payload, Low Latency.
			- ULS2PS256HC / UL, Subtype 2, 256 bits payload, High Capacity.
			- ULS2PS256LL / UL, Subtype 2, 256 bits payload, Low Latency.
			- ULS2PS512LL / UL, Subtype 2, 512 bits payload, Low Latency.
			- ULS2PS768LL / UL, Subtype 2, 768 bits payload, Low Latency.
			- ULS2PS1024LL / UL, Subtype 2, 1024 bits payload, Low Latency.
			- ULS2PS1536LL / UL, Subtype 2, 1536 bits payload, Low Latency.
			- ULS2PS2048LL / UL, Subtype 2, 2048 bits payload, Low Latency.
			- ULS2PS3072LL / UL, Subtype 2, 3072 bits payload, Low Latency.
			- ULS2PS4096LL / UL, Subtype 2, 4096 bits payload, Low Latency.
			- ULS2PS6144LL / UL, Subtype 2, 6144 bits payload, Low Latency.
			- ULS2PS8192LL / UL, Subtype 2, 8192 bits payload, Low Latency.
			- ULS2PS12288LL / UL, Subtype 2, 12288 bits payload, Low Latency. \n
			:param predefined: USER| ULS1DR9K6| ULS1DR19K2| ULS1DR38K4| ULS1DR76K8| ULS1DR153K6| ULS2PS128LL| ULS2PS256HC| ULS2PS256LL| ULS2PS512LL| ULS2PS768LL| ULS2PS1024LL| ULS2PS1536LL| ULS2PS2048LL| ULS2PS3072LL| ULS2PS4096LL| ULS2PS6144LL| ULS2PS8192LL| ULS2PS12288LL
		"""
		param = Conversions.enum_scalar_to_str(predefined, enums.EvdoPredSett)
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:PREDefined {param}')





[docs]
	def preset(self) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:PRESet \n
		Snippet: driver.source.bb.evdo.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:EVDO:STATe. \n
		"""
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:PRESet')





[docs]
	def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:PRESet \n
		Snippet: driver.source.bb.evdo.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:EVDO:STATe. \n
		Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value. \n
			: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:EVDO:PRESet', opc_timeout_ms)





[docs]
	def get_slength(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EVDO:SLENgth \n
		Snippet: value: int = driver.source.bb.evdo.get_slength() \n
		(For reverse link mode only) Sets the sequence length of the arbitrary waveform component of the 1XEV-DO signal in number
		of frames. This component is calculated in advance and output in the arbitrary waveform generator. It is added to the
		real time signal components. The number of chips is determined from this sequence length. One slot of 1.67ms duration
		equals 2048 chips. \n
			:return: slength: integer Range: 4 to dynamic
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EVDO:SLENgth?')
		return Conversions.str_to_int(response)





[docs]
	def set_slength(self, slength: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:SLENgth \n
		Snippet: driver.source.bb.evdo.set_slength(slength = 1) \n
		(For reverse link mode only) Sets the sequence length of the arbitrary waveform component of the 1XEV-DO signal in number
		of frames. This component is calculated in advance and output in the arbitrary waveform generator. It is added to the
		real time signal components. The number of chips is determined from this sequence length. One slot of 1.67ms duration
		equals 2048 chips. \n
			:param slength: integer Range: 4 to dynamic
		"""
		param = Conversions.decimal_value_to_str(slength)
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:SLENgth {param}')





[docs]
	def get_state(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:EVDO:STATe \n
		Snippet: value: bool = driver.source.bb.evdo.get_state() \n
		Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n
			:return: state: 1| ON| 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EVDO:STATe?')
		return Conversions.str_to_bool(response)





[docs]
	def set_state(self, state: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:STATe \n
		Snippet: driver.source.bb.evdo.set_state(state = False) \n
		Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n
			:param state: 1| ON| 0| OFF
		"""
		param = Conversions.bool_to_str(state)
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:STATe {param}')





[docs]
	def get_stime(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EVDO:STIMe \n
		Snippet: value: int = driver.source.bb.evdo.get_stime() \n
		Sets the System Time value of the 1xEV-DO signal and the base station. The System Time value is expressed in units of 1.
		67 ms intervals (80 ms/ 48) . Note: In uplink, the value selected for system time must be multiple of 16. \n
			:return: stime: integer Range: 0 to 2199023255551
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EVDO:STIMe?')
		return Conversions.str_to_int(response)





[docs]
	def set_stime(self, stime: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EVDO:STIMe \n
		Snippet: driver.source.bb.evdo.set_stime(stime = 1) \n
		Sets the System Time value of the 1xEV-DO signal and the base station. The System Time value is expressed in units of 1.
		67 ms intervals (80 ms/ 48) . Note: In uplink, the value selected for system time must be multiple of 16. \n
			:param stime: integer Range: 0 to 2199023255551
		"""
		param = Conversions.decimal_value_to_str(stime)
		self._core.io.write(f'SOURce<HwInstance>:BB:EVDO:STIMe {param}')





[docs]
	def get_version(self) -> str:
		"""SCPI: [SOURce<HW>]:BB:EVDO:VERSion \n
		Snippet: value: str = driver.source.bb.evdo.get_version() \n
		Queries the version of the 1xEV-DO standard underlying the definitions \n
			:return: version: string
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EVDO:VERSion?')
		return trim_str_response(response)



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