Source code for RsSmw.Implementations.Source.Bb.Huwb.Sts

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 StsCls:
	"""Sts commands group definition. 7 total commands, 1 Subgroups, 6 group commands"""

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

	@property
	def data(self):
		"""data commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_data'):
			from .Data import DataCls
			self._data = DataCls(self._core, self._cmd_group)
		return self._data


[docs]	def get_cpart(self) -> str:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:CPARt \n
		Snippet: value: str = driver.source.bb.huwb.sts.get_cpart() \n
		Sets the counter part of the V valued. The value is a 32-bit value in hexadecimal representation. \n
			:return: counter_part: integer
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:STS:CPARt?')
		return trim_str_response(response)



[docs]	def set_cpart(self, counter_part: str) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:CPARt \n
		Snippet: driver.source.bb.huwb.sts.set_cpart(counter_part = rawAbc) \n
		Sets the counter part of the V valued. The value is a 32-bit value in hexadecimal representation. \n
			:param counter_part: integer
		"""
		param = Conversions.value_to_str(counter_part)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:STS:CPARt {param}')


	# noinspection PyTypeChecker

[docs]	def get_dlen(self) -> enums.HrpUwbStsDeltaLen:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:DLEN \n
		Snippet: value: enums.HrpUwbStsDeltaLen = driver.source.bb.huwb.sts.get_dlen() \n
		Queries the delta length of the scrambled timestamp sequence (STS) . \n
			:return: delta_length: DL_4| DL_8
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:STS:DLEN?')
		return Conversions.str_to_scalar_enum(response, enums.HrpUwbStsDeltaLen)



[docs]	def set_dlen(self, delta_length: enums.HrpUwbStsDeltaLen) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:DLEN \n
		Snippet: driver.source.bb.huwb.sts.set_dlen(delta_length = enums.HrpUwbStsDeltaLen.DL_4) \n
		Queries the delta length of the scrambled timestamp sequence (STS) . \n
			:param delta_length: DL_4| DL_8
		"""
		param = Conversions.enum_scalar_to_str(delta_length, enums.HrpUwbStsDeltaLen)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:STS:DLEN {param}')



[docs]	def get_dls(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:DLS \n
		Snippet: value: bool = driver.source.bb.huwb.sts.get_dls() \n
		Activates the STS source. If activated, you can select an STS data list from a designated folder to import a user defined
		STS sequence. \n
			:return: sts_datalist: 1| ON| 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:STS:DLS?')
		return Conversions.str_to_bool(response)



[docs]	def set_dls(self, sts_datalist: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:DLS \n
		Snippet: driver.source.bb.huwb.sts.set_dls(sts_datalist = False) \n
		Activates the STS source. If activated, you can select an STS data list from a designated folder to import a user defined
		STS sequence. \n
			:param sts_datalist: 1| ON| 0| OFF
		"""
		param = Conversions.bool_to_str(sts_datalist)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:STS:DLS {param}')



[docs]	def get_key(self) -> str:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:KEY \n
		Snippet: value: str = driver.source.bb.huwb.sts.get_key() \n
		Sets the key value of the scrambled timestamp sequence (STS) . The value is a 128-bit value in hexadecimal representation. \n
			:return: key: integer
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:STS:KEY?')
		return trim_str_response(response)



[docs]	def set_key(self, key: str) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:KEY \n
		Snippet: driver.source.bb.huwb.sts.set_key(key = rawAbc) \n
		Sets the key value of the scrambled timestamp sequence (STS) . The value is a 128-bit value in hexadecimal representation. \n
			:param key: integer
		"""
		param = Conversions.value_to_str(key)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:STS:KEY {param}')


	# noinspection PyTypeChecker

[docs]	def get_pc(self) -> enums.HrpUwbStspAcketConfig:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:PC \n
		Snippet: value: enums.HrpUwbStspAcketConfig = driver.source.bb.huwb.sts.get_pc() \n
		Sets the scrambled timestamp sequence (STS) packet configuration. \n
			:return: spc: SPC_0| SPC_1| SPC_2| SPC_3
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:STS:PC?')
		return Conversions.str_to_scalar_enum(response, enums.HrpUwbStspAcketConfig)



[docs]	def set_pc(self, spc: enums.HrpUwbStspAcketConfig) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:PC \n
		Snippet: driver.source.bb.huwb.sts.set_pc(spc = enums.HrpUwbStspAcketConfig.SPC_0) \n
		Sets the scrambled timestamp sequence (STS) packet configuration. \n
			:param spc: SPC_0| SPC_1| SPC_2| SPC_3
		"""
		param = Conversions.enum_scalar_to_str(spc, enums.HrpUwbStspAcketConfig)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:STS:PC {param}')



[docs]	def get_upart(self) -> str:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:UPARt \n
		Snippet: value: str = driver.source.bb.huwb.sts.get_upart() \n
		Sets the upper part of the V value. The value is a 96-bit value in hexadecimal representation. \n
			:return: upper_part: integer
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:STS:UPARt?')
		return trim_str_response(response)



[docs]	def set_upart(self, upper_part: str) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:STS:UPARt \n
		Snippet: driver.source.bb.huwb.sts.set_upart(upper_part = rawAbc) \n
		Sets the upper part of the V value. The value is a 96-bit value in hexadecimal representation. \n
			:param upper_part: integer
		"""
		param = Conversions.value_to_str(upper_part)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:STS:UPARt {param}')


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