from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class RectangleCls:
"""Rectangle commands group definition. 6 total commands, 1 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("rectangle", core, parent)
@property
def create(self):
"""create commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_create'):
from .Create import CreateCls
self._create = CreateCls(self._core, self._cmd_group)
return self._create
[docs] def get_amplitude(self) -> float:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:AMPLitude \n
Snippet: value: float = driver.source.bb.arbitrary.tsignal.rectangle.get_amplitude() \n
Sets the digital amplitude of the rectangular wave. \n
:return: amplitude: float Range: 0 to 1, Unit: FS
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:AMPLitude?')
return Conversions.str_to_float(response)
[docs] def set_amplitude(self, amplitude: float) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:AMPLitude \n
Snippet: driver.source.bb.arbitrary.tsignal.rectangle.set_amplitude(amplitude = 1.0) \n
Sets the digital amplitude of the rectangular wave. \n
:param amplitude: float Range: 0 to 1, Unit: FS
"""
param = Conversions.decimal_value_to_str(amplitude)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:AMPLitude {param}')
[docs] def get_frequency(self) -> float:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:FREQuency \n
Snippet: value: float = driver.source.bb.arbitrary.tsignal.rectangle.get_frequency() \n
Sets the frequency of the test signal. \n
:return: frequency: float Range: 100 to depends on the installed options, Unit: Hz
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:FREQuency?')
return Conversions.str_to_float(response)
[docs] def set_frequency(self, frequency: float) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:FREQuency \n
Snippet: driver.source.bb.arbitrary.tsignal.rectangle.set_frequency(frequency = 1.0) \n
Sets the frequency of the test signal. \n
:param frequency: float Range: 100 to depends on the installed options, Unit: Hz
"""
param = Conversions.decimal_value_to_str(frequency)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:FREQuency {param}')
[docs] def get_offset(self) -> float:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:OFFSet \n
Snippet: value: float = driver.source.bb.arbitrary.tsignal.rectangle.get_offset() \n
Sets the DC component. \n
:return: offset: float Range: -1 to 1, Unit: FS
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:OFFSet?')
return Conversions.str_to_float(response)
[docs] def set_offset(self, offset: float) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:OFFSet \n
Snippet: driver.source.bb.arbitrary.tsignal.rectangle.set_offset(offset = 1.0) \n
Sets the DC component. \n
:param offset: float Range: -1 to 1, Unit: FS
"""
param = Conversions.decimal_value_to_str(offset)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:OFFSet {param}')
[docs] def get_samples(self) -> int:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:SAMPles \n
Snippet: value: int = driver.source.bb.arbitrary.tsignal.rectangle.get_samples() \n
Sets the number of sample values required for the rectangular signal per period. \n
:return: samples: integer Range: 4 to 1000
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:SAMPles?')
return Conversions.str_to_int(response)
[docs] def set_samples(self, samples: int) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:TSIGnal:RECTangle:SAMPles \n
Snippet: driver.source.bb.arbitrary.tsignal.rectangle.set_samples(samples = 1) \n
Sets the number of sample values required for the rectangular signal per period. \n
:param samples: integer Range: 4 to 1000
"""
param = Conversions.decimal_value_to_str(samples)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:TSIGnal:RECTangle:SAMPles {param}')
def clone(self) -> 'RectangleCls':
"""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 = RectangleCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group