Source code for RsSmw.Implementations.Source.Bb.Dvb.Dvbx.BhConfig

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection

[docs]
class BhConfigCls:
	"""BhConfig commands group definition. 9 total commands, 5 Subgroups, 4 group commands"""

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

	@property
	def adfl(self):
		"""adfl commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_adfl'):
			from .Adfl import AdflCls
			self._adfl = AdflCls(self._core, self._cmd_group)
		return self._adfl

	@property
	def glActive(self):
		"""glActive commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_glActive'):
			from .GlActive import GlActiveCls
			self._glActive = GlActiveCls(self._core, self._cmd_group)
		return self._glActive

	@property
	def iactive(self):
		"""iactive commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_iactive'):
			from .Iactive import IactiveCls
			self._iactive = IactiveCls(self._core, self._cmd_group)
		return self._iactive

	@property
	def nactive(self):
		"""nactive commands group. 0 Sub-classes, 1 commands."""
		if not hasattr(self, '_nactive'):
			from .Nactive import NactiveCls
			self._nactive = NactiveCls(self._core, self._cmd_group)
		return self._nactive

	@property
	def sbyte(self):
		"""sbyte commands group. 1 Sub-classes, 0 commands."""
		if not hasattr(self, '_sbyte'):
			from .Sbyte import SbyteCls
			self._sbyte = SbyteCls(self._core, self._cmd_group)
		return self._sbyte

	# noinspection PyTypeChecker

[docs]
	def get_cacm(self) -> enums.DvbS2XccmAcm:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:CACM \n
		Snippet: value: enums.DvbS2XccmAcm = driver.source.bb.dvb.dvbx.bhConfig.get_cacm() \n
		Selects whether constant coding and modulation (CCM) or adaptive coding and modulation (ACM) communication is used. \n
			:return: cacm: CCM| ACM
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:CACM?')
		return Conversions.str_to_scalar_enum(response, enums.DvbS2XccmAcm)



[docs]
	def set_cacm(self, cacm: enums.DvbS2XccmAcm) -> None:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:CACM \n
		Snippet: driver.source.bb.dvb.dvbx.bhConfig.set_cacm(cacm = enums.DvbS2XccmAcm.ACM) \n
		Selects whether constant coding and modulation (CCM) or adaptive coding and modulation (ACM) communication is used. \n
			:param cacm: CCM| ACM
		"""
		param = Conversions.enum_scalar_to_str(cacm, enums.DvbS2XccmAcm)
		self._core.io.write(f'SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:CACM {param}')



[docs]
	def get_dfl(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:DFL \n
		Snippet: value: int = driver.source.bb.dvb.dvbx.bhConfig.get_dfl() \n
		Sets the data field length (DFL) . \n
			:return: df_length: integer Range: 1 to 7264
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:DFL?')
		return Conversions.str_to_int(response)



[docs]
	def set_dfl(self, df_length: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:DFL \n
		Snippet: driver.source.bb.dvb.dvbx.bhConfig.set_dfl(df_length = 1) \n
		Sets the data field length (DFL) . \n
			:param df_length: integer Range: 1 to 7264
		"""
		param = Conversions.decimal_value_to_str(df_length)
		self._core.io.write(f'SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:DFL {param}')



[docs]
	def get_upl(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:UPL \n
		Snippet: value: int = driver.source.bb.dvb.dvbx.bhConfig.get_upl() \n
		Sets the user packet length (UPL) . \n
			:return: up_length: integer Range: 1 to 8192
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:UPL?')
		return Conversions.str_to_int(response)



[docs]
	def set_upl(self, up_length: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:UPL \n
		Snippet: driver.source.bb.dvb.dvbx.bhConfig.set_upl(up_length = 1) \n
		Sets the user packet length (UPL) . \n
			:param up_length: integer Range: 1 to 8192
		"""
		param = Conversions.decimal_value_to_str(up_length)
		self._core.io.write(f'SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:UPL {param}')



[docs]
	def get_state(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:[STATe] \n
		Snippet: value: bool = driver.source.bb.dvb.dvbx.bhConfig.get_state() \n
		Inserts baseband header information in the stream. \n
			:return: state: 1| ON| 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:STATe?')
		return Conversions.str_to_bool(response)



[docs]
	def set_state(self, state: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:DVB:DVBX:BHConfig:[STATe] \n
		Snippet: driver.source.bb.dvb.dvbx.bhConfig.set_state(state = False) \n
		Inserts baseband header information in the stream. \n
			:param state: 1| ON| 0| OFF
		"""
		param = Conversions.bool_to_str(state)
		self._core.io.write(f'SOURce<HwInstance>:BB:DVB:DVBX:BHConfig:STATe {param}')


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