from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.Types import DataType
from ......Internal.StructBase import StructBase
from ......Internal.ArgStruct import ArgStruct
from ......Internal.ArgSingleList import ArgSingleList
from ......Internal.ArgSingle import ArgSingle
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs]
def set(self, carrier_index: int, state: bool) -> None:
"""
``[SOURce<HW>]:BB:MCCW:CARRier:STATe`` \n
Snippet: ``driver.source.bb.mccw.carrier.state.set(carrier_index = 1, state = False)`` \n
Switches the selected carrier on or off.
:param carrier_index: integer Range: 0 to lastCarrier
:param state: 1 | ON | 0| OFF
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('carrier_index', carrier_index, DataType.Integer), ArgSingle('state', state, DataType.Boolean))
self._core.io.write(f'SOURce<HwInstance>:BB:MCCW:CARRier:STATe {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
class StateStruct(StructBase):
"""
Response structure. Fields: \n
- 1 Carrier_Index: int: integer Range: 0 to lastCarrier
- 2 State: bool: 1 | ON | 0| OFF
"""
__meta_args_list = [
ArgStruct.scalar_int('Carrier_Index'),
ArgStruct.scalar_bool('State')]
def __init__(self):
StructBase.__init__(self, self)
self.Carrier_Index: int = None
self.State: bool = None
[docs]
def get(self) -> StateStruct:
"""
``[SOURce<HW>]:BB:MCCW:CARRier:STATe`` \n
Snippet: ``value: StateStruct = driver.source.bb.mccw.carrier.state.get()`` \n
Switches the selected carrier on or off.
:return: structure: for return value, see the help for StateStruct structure arguments.
"""
return self._core.io.query_struct(f'SOURce<HwInstance>:BB:MCCW:CARRier:STATe?', self.__class__.StateStruct())