from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CarrierCls:
"""
| Commands in total: 8
| Subgroups: 3
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("carrier", core, parent)
@property
def execute(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_execute'):
from .Execute import ExecuteCls
self._execute = ExecuteCls(self._core, self._cmd_group)
return self._execute
@property
def phase(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_phase'):
from .Phase import PhaseCls
self._phase = PhaseCls(self._core, self._cmd_group)
return self._phase
@property
def power(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_power'):
from .Power import PowerCls
self._power = PowerCls(self._core, self._cmd_group)
return self._power
[docs]
def get_start(self) -> int:
"""
``[SOURce<HW>]:BB:MCCW:EDIT:CARRier:STARt`` \n
Snippet: ``value: int = driver.source.bb.mccw.edit.carrier.get_start()`` \n
Defines the first/last carrier in the carrier range to which joint configuration applies.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:EDIT:CARRier:STARt?')
return Conversions.str_to_int(response)
[docs]
def set_start(self, start: int) -> None:
"""
``[SOURce<HW>]:BB:MCCW:EDIT:CARRier:STARt`` \n
Snippet: ``driver.source.bb.mccw.edit.carrier.set_start(start = 1)`` \n
Defines the first/last carrier in the carrier range to which joint configuration applies.
:param start: integer Range: 0 to 8191
"""
param = Conversions.decimal_value_to_str(start)
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:EDIT:CARRier:STARt {param}')
[docs]
def get_state(self) -> bool:
"""
``[SOURce<HW>]:BB:MCCW:EDIT:CARRier:STATe`` \n
Snippet: ``value: bool = driver.source.bb.mccw.edit.carrier.get_state()`` \n
Switches all the carriers in the selected carrier range on or off.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:EDIT:CARRier:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""
``[SOURce<HW>]:BB:MCCW:EDIT:CARRier:STATe`` \n
Snippet: ``driver.source.bb.mccw.edit.carrier.set_state(state = False)`` \n
Switches all the carriers in the selected carrier range on or off.
:param state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:EDIT:CARRier:STATe {param}')
[docs]
def get_stop(self) -> int:
"""
``[SOURce<HW>]:BB:MCCW:EDIT:CARRier:STOP`` \n
Snippet: ``value: int = driver.source.bb.mccw.edit.carrier.get_stop()`` \n
Defines the first/last carrier in the carrier range to which joint configuration applies.
:return: stop: integer Range: 0 to 8191
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:MCCW:EDIT:CARRier:STOP?')
return Conversions.str_to_int(response)
[docs]
def set_stop(self, stop: int) -> None:
"""
``[SOURce<HW>]:BB:MCCW:EDIT:CARRier:STOP`` \n
Snippet: ``driver.source.bb.mccw.edit.carrier.set_stop(stop = 1)`` \n
Defines the first/last carrier in the carrier range to which joint configuration applies.
:param stop: integer Range: 0 to 8191
"""
param = Conversions.decimal_value_to_str(stop)
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:EDIT:CARRier:STOP {param}')
def clone(self) -> 'CarrierCls':
"""
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 = CarrierCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group