from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class CdefinitionCls:
"""Cdefinition commands group definition. 4 total commands, 0 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cdefinition", core, parent)
[docs] def get_rchannel(self) -> int:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition:RCHannel \n
Snippet: value: int = driver.source.afRf.generator.cdefinition.get_rchannel() \n
Assigns a reference channel number to the reference frequency defined via method RsCma.Source.AfRf.Generator.Cdefinition.
rfrequency. This setting is part of the channel definition. \n
:return: reference_ch: Range: 0 Ch to 9999 Ch, Unit: Ch
"""
response = self._core.io.query_str('SOURce:AFRF:GENerator<Instance>:CDEFinition:RCHannel?')
return Conversions.str_to_int(response)
[docs] def set_rchannel(self, reference_ch: int) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition:RCHannel \n
Snippet: driver.source.afRf.generator.cdefinition.set_rchannel(reference_ch = 1) \n
Assigns a reference channel number to the reference frequency defined via method RsCma.Source.AfRf.Generator.Cdefinition.
rfrequency. This setting is part of the channel definition. \n
:param reference_ch: Range: 0 Ch to 9999 Ch, Unit: Ch
"""
param = Conversions.decimal_value_to_str(reference_ch)
self._core.io.write(f'SOURce:AFRF:GENerator<Instance>:CDEFinition:RCHannel {param}')
[docs] def get_rfrequency(self) -> float:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition:RFRequency \n
Snippet: value: float = driver.source.afRf.generator.cdefinition.get_rfrequency() \n
Assigns a reference frequency to the reference channel number defined via method RsCma.Source.AfRf.Generator.Cdefinition.
rchannel. This setting is part of the channel definition. \n
:return: reference_freq: Range: 100 kHz to 3 GHz, Unit: Hz
"""
response = self._core.io.query_str('SOURce:AFRF:GENerator<Instance>:CDEFinition:RFRequency?')
return Conversions.str_to_float(response)
[docs] def set_rfrequency(self, reference_freq: float) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition:RFRequency \n
Snippet: driver.source.afRf.generator.cdefinition.set_rfrequency(reference_freq = 1.0) \n
Assigns a reference frequency to the reference channel number defined via method RsCma.Source.AfRf.Generator.Cdefinition.
rchannel. This setting is part of the channel definition. \n
:param reference_freq: Range: 100 kHz to 3 GHz, Unit: Hz
"""
param = Conversions.decimal_value_to_str(reference_freq)
self._core.io.write(f'SOURce:AFRF:GENerator<Instance>:CDEFinition:RFRequency {param}')
[docs] def get_cspace(self) -> float:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition:CSPace \n
Snippet: value: float = driver.source.afRf.generator.cdefinition.get_cspace() \n
Defines the channel spacing, that is the center frequency difference of two adjacent channels. This setting is part of
the channel definition. \n
:return: channel_space: Range: 100 Hz to 4 MHz, Unit: Hz
"""
response = self._core.io.query_str('SOURce:AFRF:GENerator<Instance>:CDEFinition:CSPace?')
return Conversions.str_to_float(response)
[docs] def set_cspace(self, channel_space: float) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition:CSPace \n
Snippet: driver.source.afRf.generator.cdefinition.set_cspace(channel_space = 1.0) \n
Defines the channel spacing, that is the center frequency difference of two adjacent channels. This setting is part of
the channel definition. \n
:param channel_space: Range: 100 Hz to 4 MHz, Unit: Hz
"""
param = Conversions.decimal_value_to_str(channel_space)
self._core.io.write(f'SOURce:AFRF:GENerator<Instance>:CDEFinition:CSPace {param}')
[docs] def get_value(self) -> bool:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition \n
Snippet: value: bool = driver.source.afRf.generator.cdefinition.get_value() \n
Activates or deactivates the channel definition. \n
:return: enable: OFF | ON
"""
response = self._core.io.query_str('SOURce:AFRF:GENerator<Instance>:CDEFinition?')
return Conversions.str_to_bool(response)
[docs] def set_value(self, enable: bool) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:CDEFinition \n
Snippet: driver.source.afRf.generator.cdefinition.set_value(enable = False) \n
Activates or deactivates the channel definition. \n
:param enable: OFF | ON
"""
param = Conversions.bool_to_str(enable)
self._core.io.write(f'SOURce:AFRF:GENerator<Instance>:CDEFinition {param}')