from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class BandCls:
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("band", core, parent)
[docs]
def set(self, band: enums.Band) -> None:
"""
``[SENSe]:MIXer:HARMonic:BAND`` \n
Snippet: ``driver.sense.mixer.harmonic.band.set(band = enums.Band.A)`` \n
Selects the external mixer band. The query returns the currently selected band. Is only available if the external mixer
is active (see method ``RsFsw.applications.k50Spurious.sense.mixer.state.set()`` ) .
:param band: KA | Q | U | V | E | W | F | D | G | Y | J | USER Standard waveguide band or user-defined band.
"""
param = Conversions.enum_scalar_to_str(band, enums.Band)
self._core.io.write(f'SENSe:MIXer:HARMonic:BAND {param}')
# noinspection PyTypeChecker
[docs]
def get(self) -> enums.Band:
"""
``[SENSe]:MIXer:HARMonic:BAND`` \n
Snippet: ``value: enums.Band = driver.sense.mixer.harmonic.band.get()`` \n
Selects the external mixer band. The query returns the currently selected band. Is only available if the external mixer
is active (see method ``RsFsw.applications.k50Spurious.sense.mixer.state.set()`` ) .
:return: band: KA | Q | U | V | E | W | F | D | G | Y | J | USER Standard waveguide band or user-defined band.
"""
response = self._core.io.query_str(f'SENSe:MIXer:HARMonic:BAND?')
return Conversions.str_to_scalar_enum(response, enums.Band)
[docs]
def preset(self) -> None:
"""
``[SENSe]:MIXer:HARMonic:BAND:PRESet`` \n
Snippet: ``driver.sense.mixer.harmonic.band.preset()`` \n
Restores the preset frequency ranges for the selected standard waveguide band. Note: Changes to the band and mixer
settings are maintained even after using the [PRESET] function. Use this command to restore the predefined band ranges.
"""
self._core.io.write(f'SENSe:MIXer:HARMonic:BAND:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``[SENSe]:MIXer:HARMonic:BAND:PRESet`` \n
Snippet: ``driver.sense.mixer.harmonic.band.preset_with_opc()`` \n
Restores the preset frequency ranges for the selected standard waveguide band. Note: Changes to the band and mixer
settings are maintained even after using the [PRESET] function. Use this command to restore the predefined band ranges.
Same as preset, but waits for the operation to complete before continuing further. Use the RsFsw.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'SENSe:MIXer:HARMonic:BAND:PRESet', opc_timeout_ms)