from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PhzCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("phz", core, parent)
[docs]
def set(self, state: bool, window=repcap.Window.Default, marker=repcap.Marker.Default, subBlock=repcap.SubBlock.Default) -> None:
"""
``CALCulate<n>:MARKer<m>:FUNCtion:POWer<sb>:RESult:PHZ`` \n
Snippet: ``driver.calculate.marker.function.power.result.phz.set(state = False, window = repcap.Window.Default, marker = repcap.Marker.Default, subBlock = repcap.SubBlock.Default)`` \n
Selects the unit the FSW returns results for power measurements. You can query results with method
``RsFsw.calculate.marker.function.power.result.set()`` . For LTE and 5G applications, use the command method
``RsFsw.calculate.marker.function.power.result.unit.set()`` .
:param state: ON | OFF | 1 | 0 ON | 1 Channel power density in dBm/Hz OFF | 0 Channel power in dBm
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
:param subBlock: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power')
"""
param = Conversions.bool_to_str(state)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
subBlock_cmd_val = self._cmd_group.get_repcap_cmd_value(subBlock, repcap.SubBlock)
self._core.io.write(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:FUNCtion:POWer{subBlock_cmd_val}:RESult:PHZ {param}')
[docs]
def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default, subBlock=repcap.SubBlock.Default) -> bool:
"""
``CALCulate<n>:MARKer<m>:FUNCtion:POWer<sb>:RESult:PHZ`` \n
Snippet: ``value: bool = driver.calculate.marker.function.power.result.phz.get(window = repcap.Window.Default, marker = repcap.Marker.Default, subBlock = repcap.SubBlock.Default)`` \n
Selects the unit the FSW returns results for power measurements. You can query results with method
``RsFsw.calculate.marker.function.power.result.set()`` . For LTE and 5G applications, use the command method
``RsFsw.calculate.marker.function.power.result.unit.set()`` .
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
:param subBlock: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power')
:return: state: ON | OFF | 1 | 0 ON | 1 Channel power density in dBm/Hz OFF | 0 Channel power in dBm
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
subBlock_cmd_val = self._cmd_group.get_repcap_cmd_value(subBlock, repcap.SubBlock)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:FUNCtion:POWer{subBlock_cmd_val}:RESult:PHZ?')
return Conversions.str_to_bool(response)