from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class HarmonicsCls:
"""
| Commands in total: 14
| Subgroups: 3
| Direct child commands: 7
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("harmonics", core, parent)
@property
def execute(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_execute'):
from .Execute import ExecuteCls
self._execute = ExecuteCls(self._core, self._cmd_group)
return self._execute
@property
def report(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_report'):
from .Report import ReportCls
self._report = ReportCls(self._core, self._cmd_group)
return self._report
@property
def result(self):
"""
| Commands in total: 5
| Subgroups: 5
| Direct child commands: 0
"""
if not hasattr(self, '_result'):
from .Result import ResultCls
self._result = ResultCls(self._core, self._cmd_group)
return self._result
# noinspection PyTypeChecker
[docs]
def get_volt(self) -> enums.PwrDisplayVoltage:
"""
``POWer:HARMonics:VOLT`` \n
Snippet: ``value: enums.PwrDisplayVoltage = driver.power.harmonics.get_volt()`` \n
Selects if the voltage results are displayed or not for Standard > RTCA DO-160 and enabled Evaluation with voltage source
and revised current law.
"""
response = self._core.io.query_str('POWer:HARMonics:VOLT?')
return Conversions.str_to_scalar_enum(response, enums.PwrDisplayVoltage)
[docs]
def set_volt(self, doa_display_voltage_res: enums.PwrDisplayVoltage) -> None:
"""
``POWer:HARMonics:VOLT`` \n
Snippet: ``driver.power.harmonics.set_volt(doa_display_voltage_res = enums.PwrDisplayVoltage.NOVOLTDISP)`` \n
Selects if the voltage results are displayed or not for Standard > RTCA DO-160 and enabled Evaluation with voltage source
and revised current law.
:param doa_display_voltage_res: VOLTDISP | NOVOLTDISP
"""
param = Conversions.enum_scalar_to_str(doa_display_voltage_res, enums.PwrDisplayVoltage)
self._core.io.write(f'POWer:HARMonics:VOLT {param}')
# noinspection PyTypeChecker
[docs]
def get_eval(self) -> enums.RevisionState:
"""
``POWer:HARMonics:EVAL`` \n
Snippet: ``value: enums.RevisionState = driver.power.harmonics.get_eval()`` \n
Sets the evaluation of the results for Standard > RTCA DO-160.
"""
response = self._core.io.query_str('POWer:HARMonics:EVAL?')
return Conversions.str_to_scalar_enum(response, enums.RevisionState)
[docs]
def set_eval(self, doa_analysis_revised_curr: enums.RevisionState) -> None:
"""
``POWer:HARMonics:EVAL`` \n
Snippet: ``driver.power.harmonics.set_eval(doa_analysis_revised_curr = enums.RevisionState.NOREVISED)`` \n
Sets the evaluation of the results for Standard > RTCA DO-160.
:param doa_analysis_revised_curr: REVISED | NOREVISED
"""
param = Conversions.enum_scalar_to_str(doa_analysis_revised_curr, enums.RevisionState)
self._core.io.write(f'POWer:HARMonics:EVAL {param}')
# noinspection PyTypeChecker
[docs]
def get_dofr(self) -> enums.PwrHarmFrequencyDoa160:
"""
``POWer:HARMonics:DOFR`` \n
Snippet: ``value: enums.PwrHarmFrequencyDoa160 = driver.power.harmonics.get_dofr()`` \n
Selects the frequency of the input signal.
"""
response = self._core.io.query_str('POWer:HARMonics:DOFR?')
return Conversions.str_to_scalar_enum(response, enums.PwrHarmFrequencyDoa160)
[docs]
def set_dofr(self, frequency_doa_160: enums.PwrHarmFrequencyDoa160) -> None:
"""
``POWer:HARMonics:DOFR`` \n
Snippet: ``driver.power.harmonics.set_dofr(frequency_doa_160 = enums.PwrHarmFrequencyDoa160.F360)`` \n
Selects the frequency of the input signal.
:param frequency_doa_160: F360 | F400 | F650 | F800
"""
param = Conversions.enum_scalar_to_str(frequency_doa_160, enums.PwrHarmFrequencyDoa160)
self._core.io.write(f'POWer:HARMonics:DOFR {param}')
# noinspection PyTypeChecker
[docs]
def get_mifr(self) -> enums.PwrHarmFrequencyMil1399:
"""
``POWer:HARMonics:MIFR`` \n
Snippet: ``value: enums.PwrHarmFrequencyMil1399 = driver.power.harmonics.get_mifr()`` \n
Selects the frequency of the input signal.
"""
response = self._core.io.query_str('POWer:HARMonics:MIFR?')
return Conversions.str_to_scalar_enum(response, enums.PwrHarmFrequencyMil1399)
[docs]
def set_mifr(self, frequency_mil_1399: enums.PwrHarmFrequencyMil1399) -> None:
"""
``POWer:HARMonics:MIFR`` \n
Snippet: ``driver.power.harmonics.set_mifr(frequency_mil_1399 = enums.PwrHarmFrequencyMil1399.F400)`` \n
Selects the frequency of the input signal.
:param frequency_mil_1399: F400 | F60
"""
param = Conversions.enum_scalar_to_str(frequency_mil_1399, enums.PwrHarmFrequencyMil1399)
self._core.io.write(f'POWer:HARMonics:MIFR {param}')
# noinspection PyTypeChecker
[docs]
def get_enfr(self) -> enums.PwrHarmFrequencyEn61000:
"""
``POWer:HARMonics:ENFR`` \n
Snippet: ``value: enums.PwrHarmFrequencyEn61000 = driver.power.harmonics.get_enfr()`` \n
Selects the frequency of the input signal.
"""
response = self._core.io.query_str('POWer:HARMonics:ENFR?')
return Conversions.str_to_scalar_enum(response, enums.PwrHarmFrequencyEn61000)
[docs]
def set_enfr(self, frequency_en_61000: enums.PwrHarmFrequencyEn61000) -> None:
"""
``POWer:HARMonics:ENFR`` \n
Snippet: ``driver.power.harmonics.set_enfr(frequency_en_61000 = enums.PwrHarmFrequencyEn61000.F50)`` \n
Selects the frequency of the input signal.
:param frequency_en_61000: F50 | F60
"""
param = Conversions.enum_scalar_to_str(frequency_en_61000, enums.PwrHarmFrequencyEn61000)
self._core.io.write(f'POWer:HARMonics:ENFR {param}')
# noinspection PyTypeChecker
[docs]
def get_stan(self) -> enums.PwrHarmonicsStandard:
"""
``POWer:HARMonics:STAN`` \n
Snippet: ``value: enums.PwrHarmonicsStandard = driver.power.harmonics.get_stan()`` \n
Sets a standard for the current harmonic measurement.
:return: standard_in_use: ENA | ENB | ENC | END | MIL | RTC
"""
response = self._core.io.query_str('POWer:HARMonics:STAN?')
return Conversions.str_to_scalar_enum(response, enums.PwrHarmonicsStandard)
[docs]
def set_stan(self, standard_in_use: enums.PwrHarmonicsStandard) -> None:
"""
``POWer:HARMonics:STAN`` \n
Snippet: ``driver.power.harmonics.set_stan(standard_in_use = enums.PwrHarmonicsStandard.ENA)`` \n
Sets a standard for the current harmonic measurement.
:param standard_in_use: ENA | ENB | ENC | END | MIL | RTC
"""
param = Conversions.enum_scalar_to_str(standard_in_use, enums.PwrHarmonicsStandard)
self._core.io.write(f'POWer:HARMonics:STAN {param}')
# noinspection PyTypeChecker
[docs]
def get_auto(self) -> enums.AutoScale:
"""
``POWer:HARMonics:AUTO`` \n
Snippet: ``value: enums.AutoScale = driver.power.harmonics.get_auto()`` \n
Selects the scaling for the display of the results.
:return: auto_scale: AUTO | MANUAL
"""
response = self._core.io.query_str('POWer:HARMonics:AUTO?')
return Conversions.str_to_scalar_enum(response, enums.AutoScale)
[docs]
def set_auto(self, auto_scale: enums.AutoScale) -> None:
"""
``POWer:HARMonics:AUTO`` \n
Snippet: ``driver.power.harmonics.set_auto(auto_scale = enums.AutoScale.AUTO)`` \n
Selects the scaling for the display of the results.
:param auto_scale: AUTO | MANUAL
"""
param = Conversions.enum_scalar_to_str(auto_scale, enums.AutoScale)
self._core.io.write(f'POWer:HARMonics:AUTO {param}')
def clone(self) -> 'HarmonicsCls':
"""
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 = HarmonicsCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group