from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class PtFiveCls:
"""PtFive commands group definition. 10 total commands, 1 Subgroups, 6 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("ptFive", core, parent)
@property
def cfFm(self):
"""cfFm commands group. 0 Sub-classes, 4 commands."""
if not hasattr(self, '_cfFm'):
from .CfFm import CfFmCls
self._cfFm = CfFmCls(self._core, self._cmd_group)
return self._cfFm
[docs] def get_emergency(self) -> bool:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:EMERgency \n
Snippet: value: bool = driver.source.afRf.generator.ptFive.get_emergency() \n
Configures the emergency bit to be signaled to the DUT, for P25. \n
:return: emergency: OFF | ON
"""
response = self._core.io.query_str_with_opc('SOURce:AFRF:GENerator<Instance>:PTFive:EMERgency?')
return Conversions.str_to_bool(response)
[docs] def set_emergency(self, emergency: bool) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:EMERgency \n
Snippet: driver.source.afRf.generator.ptFive.set_emergency(emergency = False) \n
Configures the emergency bit to be signaled to the DUT, for P25. \n
:param emergency: OFF | ON
"""
param = Conversions.bool_to_str(emergency)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:PTFive:EMERgency {param}')
[docs] def get_sid(self) -> float:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:SID \n
Snippet: value: float = driver.source.afRf.generator.ptFive.get_sid() \n
Configures the source ID to be signaled to the DUT. \n
:return: source_id: Range: #H0 to #HFFFFFF
"""
response = self._core.io.query_str_with_opc('SOURce:AFRF:GENerator<Instance>:PTFive:SID?')
return Conversions.str_to_float(response)
[docs] def set_sid(self, source_id: float) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:SID \n
Snippet: driver.source.afRf.generator.ptFive.set_sid(source_id = 1.0) \n
Configures the source ID to be signaled to the DUT. \n
:param source_id: Range: #H0 to #HFFFFFF
"""
param = Conversions.decimal_value_to_str(source_id)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:PTFive:SID {param}')
[docs] def get_tgid(self) -> float:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:TGID \n
Snippet: value: float = driver.source.afRf.generator.ptFive.get_tgid() \n
Configures the talk group ID to be signaled to the DUT. \n
:return: tgroup_id: Range: #H0 to #HFFFF
"""
response = self._core.io.query_str_with_opc('SOURce:AFRF:GENerator<Instance>:PTFive:TGID?')
return Conversions.str_to_float(response)
[docs] def set_tgid(self, tgroup_id: float) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:TGID \n
Snippet: driver.source.afRf.generator.ptFive.set_tgid(tgroup_id = 1.0) \n
Configures the talk group ID to be signaled to the DUT. \n
:param tgroup_id: Range: #H0 to #HFFFF
"""
param = Conversions.decimal_value_to_str(tgroup_id)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:PTFive:TGID {param}')
[docs] def get_nac(self) -> str:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:NAC \n
Snippet: value: str = driver.source.afRf.generator.ptFive.get_nac() \n
Configures the network access code to be signaled to the DUT. \n
:return: nac: Range: #H0 to #HFFF
"""
response = self._core.io.query_str_with_opc('SOURce:AFRF:GENerator<Instance>:PTFive:NAC?')
return trim_str_response(response)
[docs] def set_nac(self, nac: str) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:NAC \n
Snippet: driver.source.afRf.generator.ptFive.set_nac(nac = r1) \n
Configures the network access code to be signaled to the DUT. \n
:param nac: Range: #H0 to #HFFF
"""
param = Conversions.value_to_str(nac)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:PTFive:NAC {param}')
# noinspection PyTypeChecker
[docs] def get_pattern(self) -> enums.P25Pattern:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:PATTern \n
Snippet: value: enums.P25Pattern = driver.source.afRf.generator.ptFive.get_pattern() \n
Selects the bit pattern to be transmitted as payload for P25. \n
:return: pattern: P1011 | SILence | INTerference | BUSY | IDLE | CALibration | RSYR | RLD | C4FM | RAW1 | RA1 | RA0 | R10A | RPRB9 | RPRB15
"""
response = self._core.io.query_str_with_opc('SOURce:AFRF:GENerator<Instance>:PTFive:PATTern?')
return Conversions.str_to_scalar_enum(response, enums.P25Pattern)
[docs] def set_pattern(self, pattern: enums.P25Pattern) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:PATTern \n
Snippet: driver.source.afRf.generator.ptFive.set_pattern(pattern = enums.P25Pattern.BUSY) \n
Selects the bit pattern to be transmitted as payload for P25. \n
:param pattern: P1011 | SILence | INTerference | BUSY | IDLE | CALibration | RSYR | RLD | C4FM | RAW1 | RA1 | RA0 | R10A | RPRB9 | RPRB15
"""
param = Conversions.enum_scalar_to_str(pattern, enums.P25Pattern)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:PTFive:PATTern {param}')
# noinspection PyTypeChecker
[docs] def get_mode(self) -> enums.P25Mode:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:MODE \n
Snippet: value: enums.P25Mode = driver.source.afRf.generator.ptFive.get_mode() \n
Specifies the modulation type used for P25 phase 1 modulation. \n
:return: mode: C4FM
"""
response = self._core.io.query_str_with_opc('SOURce:AFRF:GENerator<Instance>:PTFive:MODE?')
return Conversions.str_to_scalar_enum(response, enums.P25Mode)
[docs] def set_mode(self, mode: enums.P25Mode) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:PTFive:MODE \n
Snippet: driver.source.afRf.generator.ptFive.set_mode(mode = enums.P25Mode.C4FM) \n
Specifies the modulation type used for P25 phase 1 modulation. \n
:param mode: C4FM
"""
param = Conversions.enum_scalar_to_str(mode, enums.P25Mode)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:PTFive:MODE {param}')
def clone(self) -> 'PtFiveCls':
"""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 = PtFiveCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group