from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class McarrierCls:
"""Mcarrier commands group definition. 37 total commands, 9 Subgroups, 4 group commands
Repeated Capability: Carrier, default value after init: Carrier.Nr1"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("mcarrier", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_carrier_get', 'repcap_carrier_set', repcap.Carrier.Nr1)
def repcap_carrier_set(self, carrier: repcap.Carrier) -> None:
"""Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to Carrier.Default.
Default value after init: Carrier.Nr1"""
self._cmd_group.set_repcap_enum_value(carrier)
def repcap_carrier_get(self) -> repcap.Carrier:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def carrier(self):
"""carrier commands group. 7 Sub-classes, 3 commands."""
if not hasattr(self, '_carrier'):
from .Carrier import CarrierCls
self._carrier = CarrierCls(self._core, self._cmd_group)
return self._carrier
@property
def cfactor(self):
"""cfactor commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_cfactor'):
from .Cfactor import CfactorCls
self._cfactor = CfactorCls(self._core, self._cmd_group)
return self._cfactor
@property
def clipping(self):
"""clipping commands group. 0 Sub-classes, 3 commands."""
if not hasattr(self, '_clipping'):
from .Clipping import ClippingCls
self._clipping = ClippingCls(self._core, self._cmd_group)
return self._clipping
@property
def cload(self):
"""cload commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_cload'):
from .Cload import CloadCls
self._cload = CloadCls(self._core, self._cmd_group)
return self._cload
@property
def create(self):
"""create commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_create'):
from .Create import CreateCls
self._create = CreateCls(self._core, self._cmd_group)
return self._create
@property
def edit(self):
"""edit commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_edit'):
from .Edit import EditCls
self._edit = EditCls(self._core, self._cmd_group)
return self._edit
@property
def power(self):
"""power commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_power'):
from .Power import PowerCls
self._power = PowerCls(self._core, self._cmd_group)
return self._power
@property
def setting(self):
"""setting commands group. 0 Sub-classes, 3 commands."""
if not hasattr(self, '_setting'):
from .Setting import SettingCls
self._setting = SettingCls(self._core, self._cmd_group)
return self._setting
@property
def time(self):
"""time commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_time'):
from .Time import TimeCls
self._time = TimeCls(self._core, self._cmd_group)
return self._time
[docs]
def get_clock(self) -> float:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:CLOCk \n
Snippet: value: float = driver.source.bb.arbitrary.mcarrier.get_clock() \n
Queries the resulting sample rate at which the multi-carrier waveform is output by the arbitrary waveform generator. The
output clock rate depends on the number of carriers, carrier spacing, and input sample rate of the leftmost or rightmost
carriers. \n
:return: clock: float Range: 400 to Max
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:CLOCk?')
return Conversions.str_to_float(response)
[docs]
def get_ofile(self) -> str:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:OFILe \n
Snippet: value: str = driver.source.bb.arbitrary.mcarrier.get_ofile() \n
Sets the output filename for the multicarrier waveform (file extension *.wv) . This filename is required to calculate the
waveform with the commands [:SOURce<hw>]:BB:ARBitrary:MCARrier:CLOad or [:SOURce<hw>]:BB:ARBitrary:MCARrier:CREate. \n
:return: ofile: string
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:OFILe?')
return trim_str_response(response)
[docs]
def set_ofile(self, ofile: str) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:OFILe \n
Snippet: driver.source.bb.arbitrary.mcarrier.set_ofile(ofile = 'abc') \n
Sets the output filename for the multicarrier waveform (file extension *.wv) . This filename is required to calculate the
waveform with the commands [:SOURce<hw>]:BB:ARBitrary:MCARrier:CLOad or [:SOURce<hw>]:BB:ARBitrary:MCARrier:CREate. \n
:param ofile: string
"""
param = Conversions.value_to_quoted_str(ofile)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:OFILe {param}')
[docs]
def preset(self) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:PRESet \n
Snippet: driver.source.bb.arbitrary.mcarrier.preset() \n
Sets all the multicarrier parameters to their default values. \n
"""
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:PRESet \n
Snippet: driver.source.bb.arbitrary.mcarrier.preset_with_opc() \n
Sets all the multicarrier parameters to their default values. \n
Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:PRESet', opc_timeout_ms)
[docs]
def get_samples(self) -> int:
"""SCPI: [SOURce<HW>]:BB:ARBitrary:MCARrier:SAMPles \n
Snippet: value: int = driver.source.bb.arbitrary.mcarrier.get_samples() \n
Queries the resulting file size. \n
:return: samples: integer Range: 0 to INT_MAX, Unit: samples
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:SAMPles?')
return Conversions.str_to_int(response)
def clone(self) -> 'McarrierCls':
"""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 = McarrierCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group