from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import enums
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ReferenceCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("reference", core, parent)
[docs]
def set(self, reference: enums.FreqReference, window=repcap.Window.Default) -> None:
"""
``CALCulate<n>:CHRDetection:FREQuency:REFerence`` \n
Snippet: ``driver.applications.k60Transient.calculate.chrDetection.frequency.reference.set(reference = enums.FreqReference.CENTer, window = repcap.Window.Default)`` \n
Defines the reference point for positioning the frequency measurement range. For details on the measurement range
parameters see 'Measurement range'.
:param reference: CENTer | EDGE EDGE The measurement range is defined in reference to the chirp's rising or falling edge (see method ``RsFsw.applications.k60Transient.calculate.chrDetection.frequency.offset.begin.set()`` and method ``RsFsw.applications.k60Transient.calculate.chrDetection.frequency.offset.end.set()`` ) . CENTer The measurement range is defined in reference to the center of the chirp. FMSettling The measurement range starts at the FM settling point (see method ``RsFsw.applications.k60Transient.sense.hop.fmSettling.fmSpoint.get()`` ) . PMSettling The measurement range starts at the PM settling point (see method ``RsFsw.applications.k60Transient.sense.hop.pmSettling.pmSpoint.get()`` ) .
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = Conversions.enum_scalar_to_str(reference, enums.FreqReference)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:CHRDetection:FREQuency:REFerence {param}')
# noinspection PyTypeChecker
[docs]
def get(self, window=repcap.Window.Default) -> enums.FreqReference:
"""
``CALCulate<n>:CHRDetection:FREQuency:REFerence`` \n
Snippet: ``value: enums.FreqReference = driver.applications.k60Transient.calculate.chrDetection.frequency.reference.get(window = repcap.Window.Default)`` \n
Defines the reference point for positioning the frequency measurement range. For details on the measurement range
parameters see 'Measurement range'.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: reference: CENTer | EDGE EDGE The measurement range is defined in reference to the chirp's rising or falling edge (see method ``RsFsw.applications.k60Transient.calculate.chrDetection.frequency.offset.begin.set()`` and method ``RsFsw.applications.k60Transient.calculate.chrDetection.frequency.offset.end.set()`` ) . CENTer The measurement range is defined in reference to the center of the chirp. FMSettling The measurement range starts at the FM settling point (see method ``RsFsw.applications.k60Transient.sense.hop.fmSettling.fmSpoint.get()`` ) . PMSettling The measurement range starts at the PM settling point (see method ``RsFsw.applications.k60Transient.sense.hop.pmSettling.pmSpoint.get()`` ) .
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:CHRDetection:FREQuency:REFerence?')
return Conversions.str_to_scalar_enum(response, enums.FreqReference)