from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from .......Internal.StructBase import StructBase
from .......Internal.ArgStruct import ArgStruct
from ....... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CdataCls:
"""
| Commands in total: 51
| Subgroups: 3
| Direct child commands: 45
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cdata", core, parent)
@property
def ccid(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_ccid'):
from .Ccid import CcidCls
self._ccid = CcidCls(self._core, self._cmd_group)
return self._ccid
@property
def bposition(self):
"""
| Commands in total: 4
| Subgroups: 4
| Direct child commands: 0
"""
if not hasattr(self, '_bposition'):
from .Bposition import BpositionCls
self._bposition = BpositionCls(self._core, self._cmd_group)
return self._bposition
@property
def channel(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_channel'):
from .Channel import ChannelCls
self._channel = ChannelCls(self._core, self._cmd_group)
return self._channel
# noinspection PyTypeChecker
[docs]
def get_aci(self) -> enums.BtoCsCtrlAci:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:ACI`` \n
Snippet: ``value: enums.BtoCsCtrlAci = driver.source.bb.btooth.cs.cdata.get_aci()`` \n
Sets the antenna configuration index (ACI) field. The value has a length of 1 octet or 0 to 7 in decimal representation.
:return: aci: ACI0 | ACI1 | ACI2 | ACI3 | ACI4 | ACI5 | ACI6 | ACI7
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:ACI?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlAci)
[docs]
def get_ce_count(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:CECount`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_ce_count()`` \n
Sets the 16-bit connEventCount field bits in hexadecimal representation.
:return: conn_event_count: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:CECount?')
return Conversions.str_to_int(response)
[docs]
def get_cid(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:CID`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_cid()`` \n
Sets the 6-bit Config_ID field that is the CS configuration ID. Settable ID values are 2 bits in decimal representation.
All other values are for future use.
:return: config_id: integer Range: 0 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:CID?')
return Conversions.str_to_int(response)
[docs]
def get_csa_threec(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:CSAThreec`` \n
Snippet: ``value: bool = driver.source.bb.btooth.cs.cdata.get_csa_threec()`` \n
Enables the channel selection algorithm #3c.
:return: csa_threec: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:CSAThreec?')
return Conversions.str_to_bool(response)
[docs]
def get_csignal(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:CSIGnal`` \n
Snippet: ``value: bool = driver.source.bb.btooth.cs.cdata.get_csignal()`` \n
Enables the companion signal. See also 'Companion Signal'.
:return: companion_signal: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:CSIGnal?')
return Conversions.str_to_bool(response)
# noinspection PyTypeChecker
[docs]
def get_csp_capability(self) -> enums.BtoCsCtrlSyncPhy:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:CSPCapability`` \n
Snippet: ``value: enums.BtoCsCtrlSyncPhy = driver.source.bb.btooth.cs.cdata.get_csp_capability()`` \n
Queries the value of the CS_SYNC_PHY_Capability field that is the LE 2M PHY.
:return: sync_phy: LE2M
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:CSPCapability?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlSyncPhy)
# noinspection PyTypeChecker
[docs]
class EcodeStruct(StructBase):
"""
Structure for reading output parameters. Fields: \n
- Ecode: str: numeric
- Bitcount: int: integer Range: 8 to 8
"""
__meta_args_list = [
ArgStruct.scalar_raw_str('Ecode'),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Ecode: str=None
self.Bitcount: int=None
[docs]
def get_ecode(self) -> EcodeStruct:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:ECODe`` \n
Snippet: ``value: EcodeStruct = driver.source.bb.btooth.cs.cdata.get_ecode()`` \n
Sets an 8-bit error code. For an LL_CS_TERMINATE_IND packet, informs the remote device about the termination of the
connection.
:return: structure: for return value, see the help for EcodeStruct structure arguments.
"""
return self._core.io.query_struct('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:ECODe?', self.__class__.EcodeStruct())
[docs]
def get_eoffset(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:EOFFset`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_eoffset()`` \n
Sets the time value of the Offset field. The value has a length of three octets or 9 bits.
:return: event_offset: integer Range: 500 to 4e6
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:EOFFset?')
return Conversions.str_to_int(response)
[docs]
def get_ma_path(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MAPath`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_ma_path()`` \n
Sets the maximum Num_Ant paths.
:return: max_ant_path: integer Range: 1 to 4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MAPath?')
return Conversions.str_to_int(response)
[docs]
def get_mma_steps(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMASteps`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_mma_steps()`` \n
Sets the maximum number of main mode steps.
:return: mm_max_steps: integer Range: 2 to 255
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MMASteps?')
return Conversions.str_to_int(response)
[docs]
def get_mmi_steps(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMISteps`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_mmi_steps()`` \n
Sets the minimum number of main mode steps.
:return: mm_min_steps: integer Range: 2 to 255
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MMISteps?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_mmode(self) -> enums.BtoCsMainMode:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMODe`` \n
Snippet: ``value: enums.BtoCsMainMode = driver.source.bb.btooth.cs.cdata.get_mmode()`` \n
Sets the main mode of the CS LL Control PDU. For an overview on available submodes per main mode, see Table 'CS step main
modes and submodes'.
:return: main_mode: MODE1 | MODE2 | MODE3 For a description, see method ``RsSmw.source.bb.btooth.cs.sevent.mmode.get()`` .
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MMODe?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsMainMode)
[docs]
def get_mm_repetition(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMRepetition`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_mm_repetition()`` \n
Sets the main mode repetition.
:return: mm_repetition: integer Range: 0 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MMRepetition?')
return Conversions.str_to_int(response)
[docs]
def get_mp_length(self) -> float:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MPLength`` \n
Snippet: ``value: float = driver.source.bb.btooth.cs.cdata.get_mp_length()`` \n
Sets the time value of the Max_Procedure_Len field. The value has a length of two octets or 6 bits.
:return: mp_length: float Range: 2.5 to 40959375
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MPLength?')
return Conversions.str_to_float(response)
[docs]
def get_mp_supported(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MPSupported`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_mp_supported()`` \n
Sets the bits of the Max_Procedures_Supported field.
:return: mp_supported: integer Range: 0 to 4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MPSupported?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_mtype(self) -> enums.BtoCsCtrlModeType:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MTYPe`` \n
Snippet: ``value: enums.BtoCsCtrlModeType = driver.source.bb.btooth.cs.cdata.get_mtype()`` \n
Queries the CS LL control packet mode type that is Mode-3.
:return: mode_type: MODE3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MTYPe?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlModeType)
[docs]
def get_mz_steps(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:MZSTeps`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_mz_steps()`` \n
Sets the number of Mode-0 steps.
:return: mode_0_steps: integer Range: 1 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:MZSTeps?')
return Conversions.str_to_int(response)
[docs]
def get_nant(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:NANT`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_nant()`` \n
Sets the bits of the Num_Ant field. This field indicates the number of antenna elements of the channel sounding device.
:return: num_ant: integer Range: 1 to 4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:NANT?')
return Conversions.str_to_int(response)
[docs]
def get_nconfig(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:NCONfig`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_nconfig()`` \n
Sets the Num_Configs field that relates to the number of independent CS configurations.
:return: num_config: integer Range: 1 to 4
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:NCONfig?')
return Conversions.str_to_int(response)
[docs]
def get_nfae(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:NFAE`` \n
Snippet: ``value: bool = driver.source.bb.btooth.cs.cdata.get_nfae()`` \n
Sets the No_FAE bit. This bit indicates if the transmitting LE device supports a fractional frequency offset actuation
error (FAE) or not.
:return: no_fae: 1 | ON | 0| OFF 1 | ON The transmitting LE device only supports an FAE of zero. 0 | OFF The transmitting LE device supports FAE values as listed in an FAE table.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:NFAE?')
return Conversions.str_to_bool(response)
# noinspection PyTypeChecker
[docs]
def get_nrs_capability(self) -> enums.BtoCsCtrlNadm:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:NRSCapability`` \n
Snippet: ``value: enums.BtoCsCtrlNadm = driver.source.bb.btooth.cs.cdata.get_nrs_capability()`` \n
Sets the NADM random sequence capability.
:return: nrs_capability: NONADM | NADM NONADM NADM disabled NADM NADM enabled
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:NRSCapability?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlNadm)
# noinspection PyTypeChecker
[docs]
def get_ns_capability(self) -> enums.BtoCsCtrlNadm:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:NSCapability`` \n
Snippet: ``value: enums.BtoCsCtrlNadm = driver.source.bb.btooth.cs.cdata.get_ns_capability()`` \n
Sets the NADM sounding sequence capability.
:return: ns_capability: NONADM | NADM NONADM NADM disabled NADM NADM enabled
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:NSCapability?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlNadm)
[docs]
def get_omax(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:OMAX`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_omax()`` \n
Sets the time value of the Offset_Max field. The value has a length of 3 octets or 9 bits.
:return: offset_max: integer Range: 500 to 16777215
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:OMAX?')
return Conversions.str_to_int(response)
[docs]
def get_omin(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:OMIN`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_omin()`` \n
Sets the time value of the Offset_Min field. The value has a length of 3 octets or 9 bits.
:return: offset_min: integer Range: 500 to 4e6
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:OMIN?')
return Conversions.str_to_int(response)
[docs]
def get_pcount(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:PCOunt`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_pcount()`` \n
Sets the bits in the Procedure_Count field. The value has a length of 2 octets.
:return: proc_count: integer Range: 1 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:PCOunt?')
return Conversions.str_to_int(response)
[docs]
def get_pdelta(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:PDELta`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_pdelta()`` \n
Sets the bits in the Pwr_Delta field. The value has a length of 1 octets or 3 bits.
:return: pwr_delta: integer Range: 0 to 255
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:PDELta?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_phy(self) -> enums.BtoPackFormat:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:PHY`` \n
Snippet: ``value: enums.BtoPackFormat = driver.source.bb.btooth.cs.cdata.get_phy()`` \n
Queries the PHY field value. This value indicates the TX PHY of the remote device to which the Pwr_Delta field in this
PDU applies.
:return: phy: L1M | L2M | LCOD | L2M2B For a description, see method ``RsSmw.source.bb.btooth.pformat()`` .
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:PHY?')
return Conversions.str_to_scalar_enum(response, enums.BtoPackFormat)
[docs]
def get_pinterval(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:PINTerval`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_pinterval()`` \n
Sets the procedure interval in the Procedure_Interval field. The value has a length of two octets or 6 bits.
:return: proc_interval: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:PINTerval?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_pp_antenna(self) -> enums.BtoCsCtrlAnt:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:PPANtenna`` \n
Snippet: ``value: enums.BtoCsCtrlAnt = driver.source.bb.btooth.cs.cdata.get_pp_antenna()`` \n
Sets the bits in the Preferred_Peer_Ant field. The value has a length of one octet or 3 bits.
The table Table 'Preferred_Peer_Ant field values' lists all possible values and their meaning.
:return: pp_antenna: ANT0 | ANT1 | ANT2 | ANT3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:PPANtenna?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlAnt)
# noinspection PyTypeChecker
[docs]
def get_ra_only(self) -> enums.BtoCsCtrlAccReq:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:RAONly`` \n
Snippet: ``value: enums.BtoCsCtrlAccReq = driver.source.bb.btooth.cs.cdata.get_ra_only()`` \n
Queries or sets the time values of the RTT_AA_Only_N field. Setting the value depends on the bits of the RTT_Capability
field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table 'RTT_Capability bit numbers and
RTT fields' for an overview.
:return: rtt_aa_only: AR150 | AR10 | AR0
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:RAONly?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlAccReq)
# noinspection PyTypeChecker
[docs]
def get_rcapability(self) -> enums.BtoCsCtrlRttCap:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:RCAPability`` \n
Snippet: ``value: enums.BtoCsCtrlRttCap = driver.source.bb.btooth.cs.cdata.get_rcapability()`` \n
Sets the bits in the RTT_Capability field. These bits determine the time values for the RTT_AA_Only_N field, the
RTT_Sounding_N field and the RTT_Random_Sequence_N field.
:return: rtt_capability: CAP0 | CAP1 | CAP2 See the table Table 'RTT_Capability bit numbers and RTT fields' for an overview.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:RCAPability?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlRttCap)
[docs]
def get_rfu(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:RFU`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_rfu()`` \n
Sets the bits that are reserved for future use (RFU) . The number of RFU bits can vary depending on the CS_Control_Data
PDU.
:return: rfu: integer Range: 0 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:RFU?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_rr_sequence(self) -> enums.BtoCsCtrlAccReq:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:RRSequence`` \n
Snippet: ``value: enums.BtoCsCtrlAccReq = driver.source.bb.btooth.cs.cdata.get_rr_sequence()`` \n
Queries or sets the time values of the RTT_Random_Sequence_N field. Setting the value depends on the bits of the
RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table 'RTT_Capability bit
numbers and RTT fields' for an overview.
:return: rr_sequence: AR150 | AR10 | AR0
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:RRSequence?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlAccReq)
# noinspection PyTypeChecker
[docs]
def get_rsounding(self) -> enums.BtoCsCtrlAccReq:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:RSOunding`` \n
Snippet: ``value: enums.BtoCsCtrlAccReq = driver.source.bb.btooth.cs.cdata.get_rsounding()`` \n
Queries or sets the time values of the RTT_Sounding_N field. Setting the value depends on the bits of the RTT_Capability
field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table 'RTT_Capability bit numbers and
RTT fields' for an overview.
:return: rsounding: AR150 | AR10 | AR0
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:RSOunding?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlAccReq)
# noinspection PyTypeChecker
[docs]
def get_rtype(self) -> enums.BtoCsCtrlRttType:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:RTYPe`` \n
Snippet: ``value: enums.BtoCsCtrlRttType = driver.source.bb.btooth.cs.cdata.get_rtype()`` \n
Sets the RTT type determined by the 4-bit RTT_Type field. This field indicates the round trip time (RTT) variant within
the CS procedure.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:RTYPe?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCtrlRttType)
[docs]
def get_sinterval(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:SINTerval`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_sinterval()`` \n
Sets or queries the subevent interval. Setting requires BB:BTOoth:CS:SNUMber 2 or higher.
Query is for BB:BTOoth:CS:SNUMber 1. See method ``RsSmw.source.bb.btooth.cs.cdata.snumber()`` .
:return: sub_interval: integer Range: 0 to 2.7e11
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:SINTerval?')
return Conversions.str_to_int(response)
[docs]
def get_slength(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:SLENgth`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_slength()`` \n
Sets the subevent length in the Subevent_Len field. The value has a length of three octets or 9 bits.
:return: sub_length: integer Range: 1250 to 4e6
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:SLENgth?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_smode(self) -> enums.BtoCsSubMode:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:SMODe`` \n
Snippet: ``value: enums.BtoCsSubMode = driver.source.bb.btooth.cs.cdata.get_smode()`` \n
Sets the submode of the main mode.
:return: sub_mode: MODE1 | MODE2 | MODE3 | NONE See the table Table 'CS step main modes and submodes' for an overview on available submodes per main mode.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:SMODe?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsSubMode)
[docs]
def get_snumber(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:SNUMber`` \n
Snippet: ``value: int = driver.source.bb.btooth.cs.cdata.get_snumber()`` \n
Sets the number of subevents per event.
:return: sub_number: integer Range: 1 to 32
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:SNUMber?')
return Conversions.str_to_int(response)
[docs]
def get_sp_estimate(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:SPEStimate`` \n
Snippet: ``value: bool = driver.source.bb.btooth.cs.cdata.get_sp_estimate()`` \n
Sets the Sounding_PCT_Estimate bit. This bit indicates if the device supports phase correction term (PCT) estimates from
a sounding sequence or not.
:return: sp_estimate: 1 | ON | 0| OFF 1 | ON The Sounding_PCT_Estimate bit is 1. The device supports PCT estimates from a sounding sequence. 0 | OFF The Sounding_PCT_Estimate bit is 0. The device does not support PCT estimates from a sounding sequence.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:SPEStimate?')
return Conversions.str_to_bool(response)
# noinspection PyTypeChecker
[docs]
def get_tfcs(self) -> enums.BtoCsTfcs:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:TFCS`` \n
Snippet: ``value: enums.BtoCsTfcs = driver.source.bb.btooth.cs.cdata.get_tfcs()`` \n
Sets the frequency change period (T_FCS) between consecutive CS steps. The period ranges from 15 us to 150 us.
:return: tfcs: TFCS_15 | TFCS_20 | TFCS_30 | TFCS_40 | TFCS_50 | TFCS_60 | TFCS_80 | TFCS_100 | TFCS_120 | TFCS_150 TFCS_x, x represents values in microseconds.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:TFCS?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsTfcs)
# noinspection PyTypeChecker
[docs]
def get_ti_one(self) -> enums.BtoCsTiP1:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:TIONe`` \n
Snippet: ``value: enums.BtoCsTiP1 = driver.source.bb.btooth.cs.cdata.get_ti_one()`` \n
Sets the time 'T_IP1' in microseconds.
:return: tip_one: TIP1_10 | TIP1_20 | TIP1_30 | TIP1_40 | TIP1_50 | TIP1_60 | TIP1_80 | TIP1_145 TP1_x, x represents values in microseconds.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:TIONe?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsTiP1)
# noinspection PyTypeChecker
[docs]
def get_ti_two(self) -> enums.BtoCsTiP2:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:TITWo`` \n
Snippet: ``value: enums.BtoCsTiP2 = driver.source.bb.btooth.cs.cdata.get_ti_two()`` \n
Sets the time 'T_IP2' in microseconds.
:return: tip_two: TIP2_10 | TIP2_20 | TIP2_30 | TIP2_40 | TIP2_50 | TIP2_60 | TIP2_80 | TIP2_145 TIP2_x, x represents values in microseconds.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:TITWo?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsTiP2)
# noinspection PyTypeChecker
[docs]
def get_tpm(self) -> enums.BtoCsTpm:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:TPM`` \n
Snippet: ``value: enums.BtoCsTpm = driver.source.bb.btooth.cs.cdata.get_tpm()`` \n
Sets the time 'T_PM' in microseconds.
:return: tpm: TPM_10 | TPM_20 | TPM_40 | TPM_652 TPM_x, x represents values in microseconds.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:TPM?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsTpm)
# noinspection PyTypeChecker
[docs]
def get_tsw(self) -> enums.BtoCsTsw:
"""
``[SOURce<HW>]:BB:BTOoth:CS:CDATa:TSW`` \n
Snippet: ``value: enums.BtoCsTsw = driver.source.bb.btooth.cs.cdata.get_tsw()`` \n
Sets the T_SW field values that relate to the duration of the antenna switch period. The local controller uses this
period when switching antennas during active transmissions.
:return: tsw: TSW_0 | TSW_1 | TSW_2 | TSW_4 | TSW_10 Duration of the antenna switch period is 0, 1, 2, 4 or 10 microseconds.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CS:CDATa:TSW?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsTsw)
def clone(self) -> 'CdataCls':
"""
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 = CdataCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group