from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PgeneratorCls:
"""
| Commands in total: 8
| Subgroups: 2
| Direct child commands: 5
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pgenerator", core, parent)
@property
def runSingle(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_runSingle'):
from .RunSingle import RunSingleCls
self._runSingle = RunSingleCls(self._core, self._cmd_group)
return self._runSingle
@property
def file(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_file'):
from .File import FileCls
self._file = FileCls(self._core, self._cmd_group)
return self._file
[docs]
def get_enable(self) -> bool:
"""
``PGENerator:ENABle`` \n
Snippet: ``value: bool = driver.pgenerator.get_enable()`` \n
Enables the pattern generator and outputs the waveform.
:return: state: OFF | ON
"""
response = self._core.io.query_str('PGENerator:ENABle?')
return Conversions.str_to_bool(response)
[docs]
def set_enable(self, state: bool) -> None:
"""
``PGENerator:ENABle`` \n
Snippet: ``driver.pgenerator.set_enable(state = False)`` \n
Enables the pattern generator and outputs the waveform.
:param state: OFF | ON
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'PGENerator:ENABle {param}')
[docs]
def preset(self) -> None:
"""
``PGENerator:PRESet`` \n
Snippet: ``driver.pgenerator.preset()`` \n
Sets the default pattern generator settings.
"""
self._core.io.write(f'PGENerator:PRESet')
[docs]
def preset_and_wait(self, opc_timeout_ms: int = -1) -> None:
"""
``PGENerator:PRESet`` \n
Snippet: ``driver.pgenerator.preset_and_wait()`` \n
Sets the default pattern generator settings.
Same as preset, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'PGENerator:PRESet', opc_timeout_ms)
[docs]
def get_bitrate(self) -> float:
"""
``PGENerator:BITRate`` \n
Snippet: ``value: float = driver.pgenerator.get_bitrate()`` \n
Sets the number of transmitted bits per second for the pattern generator.
:return: bitrate: 1 to 40E+6
"""
response = self._core.io.query_str('PGENerator:BITRate?')
return Conversions.str_to_float(response)
[docs]
def set_bitrate(self, bitrate: float) -> None:
"""
``PGENerator:BITRate`` \n
Snippet: ``driver.pgenerator.set_bitrate(bitrate = 1.0)`` \n
Sets the number of transmitted bits per second for the pattern generator.
:param bitrate: 1 to 40E+6
"""
param = Conversions.decimal_value_to_str(bitrate)
self._core.io.write(f'PGENerator:BITRate {param}')
[docs]
def get_hlevel(self) -> float:
"""
``PGENerator:HLEVel`` \n
Snippet: ``value: float = driver.pgenerator.get_hlevel()`` \n
Sets the high level of the pattern generator signal.
:return: high_level: 1.2 to 5
"""
response = self._core.io.query_str('PGENerator:HLEVel?')
return Conversions.str_to_float(response)
[docs]
def set_hlevel(self, high_level: float) -> None:
"""
``PGENerator:HLEVel`` \n
Snippet: ``driver.pgenerator.set_hlevel(high_level = 1.0)`` \n
Sets the high level of the pattern generator signal.
:param high_level: 1.2 to 5
"""
param = Conversions.decimal_value_to_str(high_level)
self._core.io.write(f'PGENerator:HLEVel {param}')
# noinspection PyTypeChecker
[docs]
def get_run_mode(self) -> enums.RepeatMode:
"""
``PGENerator:RUNMode`` \n
Snippet: ``value: enums.RepeatMode = driver.pgenerator.get_run_mode()`` \n
Sets the duration for which the signal of the pattern generator will be output after the trigger event.
:return: run_mode: SINGle | CONTinuous
"""
response = self._core.io.query_str('PGENerator:RUNMode?')
return Conversions.str_to_scalar_enum(response, enums.RepeatMode)
[docs]
def set_run_mode(self, run_mode: enums.RepeatMode) -> None:
"""
``PGENerator:RUNMode`` \n
Snippet: ``driver.pgenerator.set_run_mode(run_mode = enums.RepeatMode.CONTinuous)`` \n
Sets the duration for which the signal of the pattern generator will be output after the trigger event.
:param run_mode: SINGle | CONTinuous
"""
param = Conversions.enum_scalar_to_str(run_mode, enums.RepeatMode)
self._core.io.write(f'PGENerator:RUNMode {param}')
def clone(self) -> 'PgeneratorCls':
"""
Clones the group by creating new object from it and its whole existing subgroups.
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group.
"""
new_group = PgeneratorCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group