from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ClockCls:
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("clock", core, parent)
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.ClockMode:
"""
``[SOURce<HW>]:BB:ONEWeb:CLOCk:MODE`` \n
Snippet: ``value: enums.ClockMode = driver.source.bb.oneweb.clock.get_mode()`` \n
Sets the type of externally supplied clock.
:return: cloc_mode: SAMPle
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:CLOCk:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ClockMode)
[docs]
def set_mode(self, cloc_mode: enums.ClockMode) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:CLOCk:MODE`` \n
Snippet: ``driver.source.bb.oneweb.clock.set_mode(cloc_mode = enums.ClockMode.SAMPle)`` \n
Sets the type of externally supplied clock.
:param cloc_mode: SAMPle
"""
param = Conversions.enum_scalar_to_str(cloc_mode, enums.ClockMode)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:CLOCk:MODE {param}')
[docs]
def get_multiplier(self) -> int:
"""
``[SOURce<HW>]:BB:ONEWeb:CLOCk:MULTiplier`` \n
Snippet: ``value: int = driver.source.bb.oneweb.clock.get_multiplier()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:CLOCk:MULTiplier?')
return Conversions.str_to_int(response)
[docs]
def set_multiplier(self, cloc_samp_mult: int) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:CLOCk:MULTiplier`` \n
Snippet: ``driver.source.bb.oneweb.clock.set_multiplier(cloc_samp_mult = 1)`` \n
No help available
"""
param = Conversions.decimal_value_to_str(cloc_samp_mult)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:CLOCk:MULTiplier {param}')
# noinspection PyTypeChecker
[docs]
def get_source(self) -> enums.ClockSourceC:
"""
``[SOURce<HW>]:BB:ONEWeb:CLOCk:SOURce`` \n
Snippet: ``value: enums.ClockSourceC = driver.source.bb.oneweb.clock.get_source()`` \n
Selects the clock source: \n
- INTernal: Internal clock reference
- ELCLock: External local clock
- EXTernal = ELCLock: Setting only Provided for backward compatibility with other Rohde & Schwarz signal generators
:return: cloc_source: INTernal | ELCLock | EXTernal
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ONEWeb:CLOCk:SOURce?')
return Conversions.str_to_scalar_enum(response, enums.ClockSourceC)
[docs]
def set_source(self, cloc_source: enums.ClockSourceC) -> None:
"""
``[SOURce<HW>]:BB:ONEWeb:CLOCk:SOURce`` \n
Snippet: ``driver.source.bb.oneweb.clock.set_source(cloc_source = enums.ClockSourceC.ELCLock)`` \n
Selects the clock source: \n
- INTernal: Internal clock reference
- ELCLock: External local clock
- EXTernal = ELCLock: Setting only Provided for backward compatibility with other Rohde & Schwarz signal generators
:param cloc_source: INTernal | ELCLock | EXTernal
"""
param = Conversions.enum_scalar_to_str(cloc_source, enums.ClockSourceC)
self._core.io.write(f'SOURce<HwInstance>:BB:ONEWeb:CLOCk:SOURce {param}')