from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PointsCls:
"""
| Commands in total: 5
| Subgroups: 0
| Direct child commands: 5
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("points", core, parent)
[docs]
def get_arate(self) -> float:
"""
``ACQuire:POINts:ARATe`` \n
Snippet: ``value: float = driver.acquire.points.get_arate()`` \n
Returns the sample rate of the ADC, before waveform processing. The result is the interleaved sample rate or the
non-interleaved one, depending on the channel usage.
:return: adc_sample_rate: 5 Gsample/s (interleaved) , 2,5 Gsample/s (non-interleaved)
"""
response = self._core.io.query_str('ACQuire:POINts:ARATe?')
return Conversions.str_to_float(response)
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.AutoManualMode:
"""
``ACQuire:POINts:MODE`` \n
Snippet: ``value: enums.AutoManualMode = driver.acquire.points.get_mode()`` \n
Selects the mode of the waveform record length adjustment. The record length is the number of waveform samples that are
stored in one waveform record after processing, including interpolation. It determines the length of the displayed
waveform.
"""
response = self._core.io.query_str('ACQuire:POINts:MODE?')
return Conversions.str_to_scalar_enum(response, enums.AutoManualMode)
[docs]
def set_mode(self, record_len_mode: enums.AutoManualMode) -> None:
"""
``ACQuire:POINts:MODE`` \n
Snippet: ``driver.acquire.points.set_mode(record_len_mode = enums.AutoManualMode.AUTO)`` \n
Selects the mode of the waveform record length adjustment. The record length is the number of waveform samples that are
stored in one waveform record after processing, including interpolation. It determines the length of the displayed
waveform.
:param record_len_mode: AUTO | MANual \n
- AUTO: Record length is determined automatically and changes due to instrument internal adjustments.
- MANual: The waveform record length is defined with ACQuire:POINts[:VALue].
"""
param = Conversions.enum_scalar_to_str(record_len_mode, enums.AutoManualMode)
self._core.io.write(f'ACQuire:POINts:MODE {param}')
[docs]
def get_value(self) -> int:
"""
``ACQuire:POINts[:VALue]`` \n
Snippet: ``value: int = driver.acquire.points.get_value()`` \n
Sets the record length, if method ``RsMxo.acquire.points.mode()`` is set to MANual.
:return: record_length: 1000 to 1E+9
"""
response = self._core.io.query_str('ACQuire:POINts:VALue?')
return Conversions.str_to_int(response)
[docs]
def set_value(self, record_length: int) -> None:
"""
``ACQuire:POINts[:VALue]`` \n
Snippet: ``driver.acquire.points.set_value(record_length = 1)`` \n
Sets the record length, if method ``RsMxo.acquire.points.mode()`` is set to MANual.
:param record_length: 1000 to 1E+9
"""
param = Conversions.decimal_value_to_str(record_length)
self._core.io.write(f'ACQuire:POINts:VALue {param}')
[docs]
def get_dvalue(self) -> int:
"""
``ACQuire:POINts:DVALue`` \n
Snippet: ``value: int = driver.acquire.points.get_dvalue()`` \n
Returns the current digital record length used by each digital channel.
:return: dig_rec_len: 1000 to 200000000
"""
response = self._core.io.query_str('ACQuire:POINts:DVALue?')
return Conversions.str_to_int(response)
[docs]
def get_maximum(self) -> int:
"""
``ACQuire:POINts:MAXimum`` \n
Snippet: ``value: int = driver.acquire.points.get_maximum()`` \n
Sets the maximum record length, if method ``RsMxo.acquire.points.mode()`` is set to AUTO.
"""
response = self._core.io.query_str('ACQuire:POINts:MAXimum?')
return Conversions.str_to_int(response)
[docs]
def set_maximum(self, record_len_user_limit: int) -> None:
"""
``ACQuire:POINts:MAXimum`` \n
Snippet: ``driver.acquire.points.set_maximum(record_len_user_limit = 1)`` \n
Sets the maximum record length, if method ``RsMxo.acquire.points.mode()`` is set to AUTO.
:param record_len_user_limit: 1000 to 1E+9
"""
param = Conversions.decimal_value_to_str(record_len_user_limit)
self._core.io.write(f'ACQuire:POINts:MAXimum {param}')