Source code for RsSmw.Implementations.Source.Bb.Graphics.SymbolRate

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection

[docs]class SymbolRateCls:
	"""SymbolRate commands group definition. 2 total commands, 0 Subgroups, 2 group commands"""

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

	# noinspection PyTypeChecker

[docs]	def get_mode(self) -> enums.TranRecSampFactMode:
		"""SCPI: [SOURce<HW>]:BB:GRAPhics:SRATe:MODE \n
		Snippet: value: enums.TranRecSampFactMode = driver.source.bb.graphics.symbolRate.get_mode() \n
		Sets how the time resolution of the signal is determined. Maximum resolution corresponds to a diagram covering the entire
		signal bandwidth. The higher the resolution is, the shorter the length of the displayed signal segment will be for the
		specified recording depth. \n
			:return: mode: AUTO| FULL| USER
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:GRAPhics:SRATe:MODE?')
		return Conversions.str_to_scalar_enum(response, enums.TranRecSampFactMode)



[docs]	def set_mode(self, mode: enums.TranRecSampFactMode) -> None:
		"""SCPI: [SOURce<HW>]:BB:GRAPhics:SRATe:MODE \n
		Snippet: driver.source.bb.graphics.symbolRate.set_mode(mode = enums.TranRecSampFactMode.AUTO) \n
		Sets how the time resolution of the signal is determined. Maximum resolution corresponds to a diagram covering the entire
		signal bandwidth. The higher the resolution is, the shorter the length of the displayed signal segment will be for the
		specified recording depth. \n
			:param mode: AUTO| FULL| USER
		"""
		param = Conversions.enum_scalar_to_str(mode, enums.TranRecSampFactMode)
		self._core.io.write(f'SOURce<HwInstance>:BB:GRAPhics:SRATe:MODE {param}')



[docs]	def get_user(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:GRAPhics:SRATe:USER \n
		Snippet: value: float = driver.source.bb.graphics.symbolRate.get_user() \n
		(Enabled for BB:GRAPH:SRAT:MODE USER) Selects the signal bandwidth for the diagram. The setting range moves between the
		minimum and maximum bandwidth which is possible for the selected graphical signal display. The selection is made
		graphically by moving the pointer. \n
			:return: user: float Range: 0.01 to 100, Unit: PCT
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:GRAPhics:SRATe:USER?')
		return Conversions.str_to_float(response)



[docs]	def set_user(self, user: float) -> None:
		"""SCPI: [SOURce<HW>]:BB:GRAPhics:SRATe:USER \n
		Snippet: driver.source.bb.graphics.symbolRate.set_user(user = 1.0) \n
		(Enabled for BB:GRAPH:SRAT:MODE USER) Selects the signal bandwidth for the diagram. The setting range moves between the
		minimum and maximum bandwidth which is possible for the selected graphical signal display. The selection is made
		graphically by moving the pointer. \n
			:param user: float Range: 0.01 to 100, Unit: PCT
		"""
		param = Conversions.decimal_value_to_str(user)
		self._core.io.write(f'SOURce<HwInstance>:BB:GRAPhics:SRATe:USER {param}')