from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# 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.DetectReference) -> None:
"""
``[SENSe]:DETect:REFerence`` \n
Snippet: ``driver.applications.k149Uwb.sense.detect.reference.set(reference = enums.DetectReference.ABSolute)`` \n
The reference level to be used for setting the pulse detection threshold.
:param reference: REFLevel | PEAK | NOISe | ABSolute REFLevel Current reference level PEAK Peak level as measured over the entire capture data interval NOISe Noise level determined from the current capture data according to SENSe:TRACe:MEASurement:DEFine:DURation:MIN. ABSolute Absolute level defined by method ``RsFsw.applications.k6Pulse.sense.detect.threshold.set()`` .
"""
param = Conversions.enum_scalar_to_str(reference, enums.DetectReference)
self._core.io.write(f'SENSe:DETect:REFerence {param}')
# noinspection PyTypeChecker
[docs]
def get(self) -> enums.DetectReference:
"""
``[SENSe]:DETect:REFerence`` \n
Snippet: ``value: enums.DetectReference = driver.applications.k149Uwb.sense.detect.reference.get()`` \n
The reference level to be used for setting the pulse detection threshold.
:return: reference: REFLevel | PEAK | NOISe | ABSolute REFLevel Current reference level PEAK Peak level as measured over the entire capture data interval NOISe Noise level determined from the current capture data according to SENSe:TRACe:MEASurement:DEFine:DURation:MIN. ABSolute Absolute level defined by method ``RsFsw.applications.k6Pulse.sense.detect.threshold.set()`` .
"""
response = self._core.io.query_str(f'SENSe:DETect:REFerence?')
return Conversions.str_to_scalar_enum(response, enums.DetectReference)