Source code for RsFsw.Implementations.Applications.K70_Vsa.Sense.Ddemod.Psk.FormatPy

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FormatPyCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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



[docs]
	def set(self, psk_format: enums.PskFormat) -> None:
		"""
		``[SENSe]:DDEMod:PSK:FORMat`` \n
		Snippet: ``driver.applications.k70Vsa.sense.ddemod.psk.formatPy.set(psk_format = enums.PskFormat.DIFFerential)`` \n
		Together with DDEMod:PSK:NST, this command defines the demodulation order for PSK (see also method
		``RsFsw.applications.k70Vsa.sense.ddemod.psk.nstate.set()`` ) . Depending on the demodulation format and state, the
		following orders are available:
		NSTATe / <PSKformat> / Order \n
			- 2 / NORMal / BPSK
			- 2 / NPI2 / Pi/2-BPSK
			- 2 / MNPI2 / Pi/2-BPSK
			- 2 / DPI2 / Pi/2-DBPSK
			- 8 / NORMal / 8PSK
			- 8 / DIFFerential / D8PSK
			- 8 / N3Pi8 / 3pi/8-8PSK (EDGE)
			- 8 / PI8D8PSK / Pi/8-D8PSK

		:param psk_format: NORMal | DIFFerential | N3Pi8 | PI8D8psk | NPI2 | DPI2 | MNPi2
		"""
		param = Conversions.enum_scalar_to_str(psk_format, enums.PskFormat)
		self._core.io.write(f'SENSe:DDEMod:PSK:FORMat {param}')



	# noinspection PyTypeChecker


[docs]
	def get(self) -> enums.PskFormat:
		"""
		``[SENSe]:DDEMod:PSK:FORMat`` \n
		Snippet: ``value: enums.PskFormat = driver.applications.k70Vsa.sense.ddemod.psk.formatPy.get()`` \n
		Together with DDEMod:PSK:NST, this command defines the demodulation order for PSK (see also method
		``RsFsw.applications.k70Vsa.sense.ddemod.psk.nstate.set()`` ) . Depending on the demodulation format and state, the
		following orders are available:
		NSTATe / <PSKformat> / Order \n
			- 2 / NORMal / BPSK
			- 2 / NPI2 / Pi/2-BPSK
			- 2 / MNPI2 / Pi/2-BPSK
			- 2 / DPI2 / Pi/2-DBPSK
			- 8 / NORMal / 8PSK
			- 8 / DIFFerential / D8PSK
			- 8 / N3Pi8 / 3pi/8-8PSK (EDGE)
			- 8 / PI8D8PSK / Pi/8-D8PSK

		:return: psk_format: NORMal | DIFFerential | N3Pi8 | PI8D8psk | NPI2 | DPI2 | MNPi2
		"""
		response = self._core.io.query_str(f'SENSe:DDEMod:PSK:FORMat?')
		return Conversions.str_to_scalar_enum(response, enums.PskFormat)