Source code for RsSmw.Implementations.Source.Regenerator.Object.Phase.Offset

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection


class OffsetCls:
	"""Offset commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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



	def set(self, offset: float, objectIx=repcap.ObjectIx.Default) -> None:
		"""SCPI: [SOURce<HW>]:REGenerator:OBJect<CH>:PHASe:[OFFSet] \n
		Snippet: driver.source.regenerator.object.phase.offset.set(offset = 1.0, objectIx = repcap.ObjectIx.Default) \n
		Sets a phase offset between the transmitted pulse and the echo signal. \n
			:param offset: float Range: 0 to 359.9
			:param objectIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Object')
		"""
		param = Conversions.decimal_value_to_str(offset)
		objectIx_cmd_val = self._cmd_group.get_repcap_cmd_value(objectIx, repcap.ObjectIx)
		self._core.io.write(f'SOURce<HwInstance>:REGenerator:OBJect{objectIx_cmd_val}:PHASe:OFFSet {param}')




	def get(self, objectIx=repcap.ObjectIx.Default) -> float:
		"""SCPI: [SOURce<HW>]:REGenerator:OBJect<CH>:PHASe:[OFFSet] \n
		Snippet: value: float = driver.source.regenerator.object.phase.offset.get(objectIx = repcap.ObjectIx.Default) \n
		Sets a phase offset between the transmitted pulse and the echo signal. \n
			:param objectIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Object')
			:return: offset: float Range: 0 to 359.9"""
		objectIx_cmd_val = self._cmd_group.get_repcap_cmd_value(objectIx, repcap.ObjectIx)
		response = self._core.io.query_str(f'SOURce<HwInstance>:REGenerator:OBJect{objectIx_cmd_val}:PHASe:OFFSet?')
		return Conversions.str_to_float(response)