from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class GeneratorCls:
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("generator", core, parent)
# noinspection PyTypeChecker
[docs]
def get_channel(self) -> enums.GeneratorChannel:
"""
``FRANalysis:GENerator[:CHANnel]`` \n
Snippet: ``value: enums.GeneratorChannel = driver.franalysis.generator.get_channel()`` \n
Selects the built-in generator to start a frequency sweep for a defined frequency range.
:return: gen_ch: GEN1 | GEN2
"""
response = self._core.io.query_str('FRANalysis:GENerator:CHANnel?')
return Conversions.str_to_scalar_enum(response, enums.GeneratorChannel)
[docs]
def set_channel(self, gen_ch: enums.GeneratorChannel) -> None:
"""
``FRANalysis:GENerator[:CHANnel]`` \n
Snippet: ``driver.franalysis.generator.set_channel(gen_ch = enums.GeneratorChannel.GEN1)`` \n
Selects the built-in generator to start a frequency sweep for a defined frequency range.
:param gen_ch: GEN1 | GEN2
"""
param = Conversions.enum_scalar_to_str(gen_ch, enums.GeneratorChannel)
self._core.io.write(f'FRANalysis:GENerator:CHANnel {param}')
[docs]
def get_amplitude(self) -> float:
"""
``FRANalysis:GENerator:AMPLitude`` \n
Snippet: ``value: float = driver.franalysis.generator.get_amplitude()`` \n
Sets a fixed amplitude for the frequency response analysis.
:return: gen_amplitude: 0.01 to 12
"""
response = self._core.io.query_str('FRANalysis:GENerator:AMPLitude?')
return Conversions.str_to_float(response)
[docs]
def set_amplitude(self, gen_amplitude: float) -> None:
"""
``FRANalysis:GENerator:AMPLitude`` \n
Snippet: ``driver.franalysis.generator.set_amplitude(gen_amplitude = 1.0)`` \n
Sets a fixed amplitude for the frequency response analysis.
:param gen_amplitude: 0.01 to 12
"""
param = Conversions.decimal_value_to_str(gen_amplitude)
self._core.io.write(f'FRANalysis:GENerator:AMPLitude {param}')
# noinspection PyTypeChecker
[docs]
def get_load(self) -> enums.WgenLoad:
"""
``FRANalysis:GENerator:LOAD`` \n
Snippet: ``value: enums.WgenLoad = driver.franalysis.generator.get_load()`` \n
Selects the generator voltage display for 50Ω or high impedance load.
:return: gen_load: HIZ: high input impedance
"""
response = self._core.io.query_str('FRANalysis:GENerator:LOAD?')
return Conversions.str_to_scalar_enum(response, enums.WgenLoad)
[docs]
def set_load(self, gen_load: enums.WgenLoad) -> None:
"""
``FRANalysis:GENerator:LOAD`` \n
Snippet: ``driver.franalysis.generator.set_load(gen_load = enums.WgenLoad.FIFTy)`` \n
Selects the generator voltage display for 50Ω or high impedance load.
:param gen_load: HIZ: high input impedance
"""
param = Conversions.enum_scalar_to_str(gen_load, enums.WgenLoad)
self._core.io.write(f'FRANalysis:GENerator:LOAD {param}')