from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class ClockCls:
"""Clock commands group definition. 6 total commands, 1 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("clock", core, parent)
@property
def synchronization(self):
"""synchronization commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_synchronization'):
from .Synchronization import SynchronizationCls
self._synchronization = SynchronizationCls(self._core, self._cmd_group)
return self._synchronization
# noinspection PyTypeChecker
[docs] def get_mode(self) -> enums.ClocModeB:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk:MODE \n
Snippet: value: enums.ClocModeB = driver.source.bb.mccw.clock.get_mode() \n
No command help available \n
:return: mode: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:CLOCk:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ClocModeB)
[docs] def set_mode(self, mode: enums.ClocModeB) -> None:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk:MODE \n
Snippet: driver.source.bb.mccw.clock.set_mode(mode = enums.ClocModeB.MSAMple) \n
No command help available \n
:param mode: No help available
"""
param = Conversions.enum_scalar_to_str(mode, enums.ClocModeB)
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:CLOCk:MODE {param}')
[docs] def get_multiplier(self) -> int:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk:MULTiplier \n
Snippet: value: int = driver.source.bb.mccw.clock.get_multiplier() \n
No command help available \n
:return: multiplier: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:CLOCk:MULTiplier?')
return Conversions.str_to_int(response)
[docs] def set_multiplier(self, multiplier: int) -> None:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk:MULTiplier \n
Snippet: driver.source.bb.mccw.clock.set_multiplier(multiplier = 1) \n
No command help available \n
:param multiplier: No help available
"""
param = Conversions.decimal_value_to_str(multiplier)
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:CLOCk:MULTiplier {param}')
# noinspection PyTypeChecker
[docs] def get_source(self) -> enums.ClockSourceA:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk:SOURce \n
Snippet: value: enums.ClockSourceA = driver.source.bb.mccw.clock.get_source() \n
INTRO_CMD_HELP: Selects the clock source: \n
- INTernal: Internal clock reference \n
:return: source: INTernal
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:CLOCk:SOURce?')
return Conversions.str_to_scalar_enum(response, enums.ClockSourceA)
[docs] def set_source(self, source: enums.ClockSourceA) -> None:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk:SOURce \n
Snippet: driver.source.bb.mccw.clock.set_source(source = enums.ClockSourceA.INTernal) \n
INTRO_CMD_HELP: Selects the clock source: \n
- INTernal: Internal clock reference \n
:param source: INTernal
"""
param = Conversions.enum_scalar_to_str(source, enums.ClockSourceA)
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:CLOCk:SOURce {param}')
[docs] def get_value(self) -> float:
"""SCPI: [SOURce<HW>]:BB:MCCW:CLOCk \n
Snippet: value: float = driver.source.bb.mccw.clock.get_value() \n
Queries the output clock rate. The output clock rate depends on the number of carriers and on the selected carrier
spacing. \n
:return: clock: float Range: 0 to Max
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:CLOCk?')
return Conversions.str_to_float(response)
def clone(self) -> 'ClockCls':
"""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 = ClockCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group