RFmx TDSCDMA CVI

Table of Contents

RFmxTDSCDMA_CfgMidambleShift

  • Updated2024-10-14
  • 2 minute(s) read

RFmxTDSCDMA_CfgMidambleShift

int32 __stdcall RFmxTDSCDMA_CfgMidambleShift (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 midambleAutoDetectionMode, int32 maximumNumberOfUsers, int32 midambleShift);

Purpose

Configures the midambleAutoDetectionMode, maximumNumberOfUsers, and RFMXTDSCDMA_VAL_MIDAMBLE_AUTO_DETECTION_MODE_MIDAMBLE_SHIFT parameters.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxTDSCDMA_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.


examples:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxTDSCDMA_BuildSignalString function to build the selector string.
midambleAutoDetectionMode int32 Enables automatic midamble detection.
RFMXTDSCDMA_VAL_MIDAMBLE_AUTO_DETECTION_MODE_OFF (0) Automatic midamble detection is disabled.
RFMXTDSCDMA_VAL_MIDAMBLE_AUTO_DETECTION_MODE_MIDAMBLE_SHIFT (1) The midamble shift is automatically detected from K possible midamble shift values, where K is specified by the maximumNumberOfUsers parameter. The K possible midamble shift values are: Midamble Shift = k * floor(P/K),where P = 128, is the length of the basic midamble code, and k is an integer from 0 to K-1.
maximumNumberOfUsers int32 Configures the maximum number of users.
midambleShift int32 Specifies the midamble shift used when the midambleAutoDetectionMode parameter is set to RFMXTDSCDMA_VAL_MIDAMBLE_AUTO_DETECTION_MODE_OFF. This value is expressed in chips.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxTDSCDMA_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience