Source code for rsmxo.Implementations.Export.Result.Select.Fra

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


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

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

[docs] def get_result(self) -> bool: """ ``EXPort:RESult:SELect:FRA:RESult`` \n Snippet: ``value: bool = driver.export.result.select.fra.get_result()`` \n If enabled, includes the frequency response analysis results, including the frequency, gain, phase and amplitude, in the results export file of the FRA. :return: result: OFF | ON """ response = self._core.io.query_str('EXPort:RESult:SELect:FRA:RESult?') return Conversions.str_to_bool(response)
[docs] def set_result(self, result: bool) -> None: """ ``EXPort:RESult:SELect:FRA:RESult`` \n Snippet: ``driver.export.result.select.fra.set_result(result = False)`` \n If enabled, includes the frequency response analysis results, including the frequency, gain, phase and amplitude, in the results export file of the FRA. :param result: OFF | ON """ param = Conversions.bool_to_str(result) self._core.io.write(f'EXPort:RESult:SELect:FRA:RESult {param}')
[docs] def get_marker(self) -> bool: """ ``EXPort:RESult:SELect:FRA:MARKer`` \n Snippet: ``value: bool = driver.export.result.select.fra.get_marker()`` \n If enabled, includes the marker results in the results export file of the FRA. :return: marker_result: OFF | ON """ response = self._core.io.query_str('EXPort:RESult:SELect:FRA:MARKer?') return Conversions.str_to_bool(response)
[docs] def set_marker(self, marker_result: bool) -> None: """ ``EXPort:RESult:SELect:FRA:MARKer`` \n Snippet: ``driver.export.result.select.fra.set_marker(marker_result = False)`` \n If enabled, includes the marker results in the results export file of the FRA. :param marker_result: OFF | ON """ param = Conversions.bool_to_str(marker_result) self._core.io.write(f'EXPort:RESult:SELect:FRA:MARKer {param}')
[docs] def get_margin(self) -> bool: """ ``EXPort:RESult:SELect:FRA:MARGin`` \n Snippet: ``value: bool = driver.export.result.select.fra.get_margin()`` \n If enabled, includes the margin results in the results export file of the FRA. :return: margin_result: OFF | ON """ response = self._core.io.query_str('EXPort:RESult:SELect:FRA:MARGin?') return Conversions.str_to_bool(response)
[docs] def set_margin(self, margin_result: bool) -> None: """ ``EXPort:RESult:SELect:FRA:MARGin`` \n Snippet: ``driver.export.result.select.fra.set_margin(margin_result = False)`` \n If enabled, includes the margin results in the results export file of the FRA. :param margin_result: OFF | ON """ param = Conversions.bool_to_str(margin_result) self._core.io.write(f'EXPort:RESult:SELect:FRA:MARGin {param}')