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

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection


[docs]
class ClippingCls:
	"""Clipping commands group definition. 3 total commands, 0 Subgroups, 3 group commands"""

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



[docs]
	def get_level(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:HUWB:CLIPping:LEVel \n
		Snippet: value: int = driver.source.bb.huwb.clipping.get_level() \n
		Sets the limit for level clipping. \n
			:return: level: integer Range: 1 to 100
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:CLIPping:LEVel?')
		return Conversions.str_to_int(response)





[docs]
	def set_level(self, level: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:CLIPping:LEVel \n
		Snippet: driver.source.bb.huwb.clipping.set_level(level = 1) \n
		Sets the limit for level clipping. \n
			:param level: integer Range: 1 to 100
		"""
		param = Conversions.decimal_value_to_str(level)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:CLIPping:LEVel {param}')



	# noinspection PyTypeChecker


[docs]
	def get_mode(self) -> enums.ClipMode:
		"""SCPI: [SOURce<HW>]:BB:HUWB:CLIPping:MODE \n
		Snippet: value: enums.ClipMode = driver.source.bb.huwb.clipping.get_mode() \n
		Sets the method for level clipping. \n
			:return: mode: VECTor| SCALar
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:CLIPping:MODE?')
		return Conversions.str_to_scalar_enum(response, enums.ClipMode)





[docs]
	def set_mode(self, mode: enums.ClipMode) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:CLIPping:MODE \n
		Snippet: driver.source.bb.huwb.clipping.set_mode(mode = enums.ClipMode.SCALar) \n
		Sets the method for level clipping. \n
			:param mode: VECTor| SCALar
		"""
		param = Conversions.enum_scalar_to_str(mode, enums.ClipMode)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:CLIPping:MODE {param}')





[docs]
	def get_state(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:HUWB:CLIPping:STATe \n
		Snippet: value: bool = driver.source.bb.huwb.clipping.get_state() \n
		Activates level clipping (Clipping) . The value is defined with the command [:SOURce:]BB:EUTRa:CLIPping:LEVel, the mode
		of calculation with the command [:SOURce:]BB:EUTRa:CLIPping:MODE. \n
			:return: state: 1| ON| 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:HUWB:CLIPping:STATe?')
		return Conversions.str_to_bool(response)





[docs]
	def set_state(self, state: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:HUWB:CLIPping:STATe \n
		Snippet: driver.source.bb.huwb.clipping.set_state(state = False) \n
		Activates level clipping (Clipping) . The value is defined with the command [:SOURce:]BB:EUTRa:CLIPping:LEVel, the mode
		of calculation with the command [:SOURce:]BB:EUTRa:CLIPping:MODE. \n
			:param state: 1| ON| 0| OFF
		"""
		param = Conversions.bool_to_str(state)
		self._core.io.write(f'SOURce<HwInstance>:BB:HUWB:CLIPping:STATe {param}')