from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class OcnsCls:
"""Ocns commands group definition. 3 total commands, 0 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("ocns", core, parent)
# noinspection PyTypeChecker
[docs] def get_mode(self) -> enums.OcnsMode:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation:OCNS:MODE \n
Snippet: value: enums.OcnsMode = driver.source.bb.w3Gpp.bstation.ocns.get_mode() \n
Selects the scenario for setting the OCNS channels. To activate the selected scenario, send the command
[:SOURce<hw>]:BB:W3GPp:BSTation:OCNS:STATe. \n
:return: mode: STANdard| HSDPa| HSDP2| M3I Four different OCNS scenarios are defined in the standard; one standard scenario, two scenarios for testing HSDPA channels and one for enhanced performance type 3i tests.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:BSTation:OCNS:MODE?')
return Conversions.str_to_scalar_enum(response, enums.OcnsMode)
[docs] def set_mode(self, mode: enums.OcnsMode) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation:OCNS:MODE \n
Snippet: driver.source.bb.w3Gpp.bstation.ocns.set_mode(mode = enums.OcnsMode.HSDP2) \n
Selects the scenario for setting the OCNS channels. To activate the selected scenario, send the command
[:SOURce<hw>]:BB:W3GPp:BSTation:OCNS:STATe. \n
:param mode: STANdard| HSDPa| HSDP2| M3I Four different OCNS scenarios are defined in the standard; one standard scenario, two scenarios for testing HSDPA channels and one for enhanced performance type 3i tests.
"""
param = Conversions.enum_scalar_to_str(mode, enums.OcnsMode)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:BSTation:OCNS:MODE {param}')
[docs] def get_seed(self) -> int:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation:OCNS:SEED \n
Snippet: value: int = driver.source.bb.w3Gpp.bstation.ocns.get_seed() \n
In '3i' OCNS mode, sets the seed for both the random processes, the power control simulation process and the process
controlling the switch over of the channelization codes. \n
:return: seed: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:BSTation:OCNS:SEED?')
return Conversions.str_to_int(response)
[docs] def set_seed(self, seed: int) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation:OCNS:SEED \n
Snippet: driver.source.bb.w3Gpp.bstation.ocns.set_seed(seed = 1) \n
In '3i' OCNS mode, sets the seed for both the random processes, the power control simulation process and the process
controlling the switch over of the channelization codes. \n
:param seed: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(seed)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:BSTation:OCNS:SEED {param}')
[docs] def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation:OCNS:STATe \n
Snippet: value: bool = driver.source.bb.w3Gpp.bstation.ocns.get_state() \n
Activates OCNS channels according to the scenario selected with the command [:SOURce<hw>]:BB:W3GPp:BSTation:OCNS:MODE. \n
:return: state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:BSTation:OCNS:STATe?')
return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation:OCNS:STATe \n
Snippet: driver.source.bb.w3Gpp.bstation.ocns.set_state(state = False) \n
Activates OCNS channels according to the scenario selected with the command [:SOURce<hw>]:BB:W3GPp:BSTation:OCNS:MODE. \n
:param state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:BSTation:OCNS:STATe {param}')