from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CfactorCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cfactor", core, parent)
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.ArbMultCarrCresMode:
"""
``[SOURce<HW>]:BB:ARBitrary:MCARrier:CFACtor:MODE`` \n
Snippet: ``value: enums.ArbMultCarrCresMode = driver.source.bb.arbitrary.mcarrier.cfactor.get_mode()`` \n
Sets the mode for optimizing the crest factor by calculating the carrier phases.
:return: mode: OFF | MIN | MAX
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:CFACtor:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ArbMultCarrCresMode)
[docs]
def set_mode(self, mode: enums.ArbMultCarrCresMode) -> None:
"""
``[SOURce<HW>]:BB:ARBitrary:MCARrier:CFACtor:MODE`` \n
Snippet: ``driver.source.bb.arbitrary.mcarrier.cfactor.set_mode(mode = enums.ArbMultCarrCresMode.MAX)`` \n
Sets the mode for optimizing the crest factor by calculating the carrier phases.
:param mode: OFF | MIN | MAX
"""
param = Conversions.enum_scalar_to_str(mode, enums.ArbMultCarrCresMode)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:CFACtor:MODE {param}')