NI RFmx LTE SlotPhase Fetch Functions

SlotPhase Fetch Functions

• RFmxLTE_SlotPhaseFetchPhaseDiscontinuities
• RFmxLTE_SlotPhaseFetchMaximumPhaseDiscontinuity
• RFmxLTE_SlotPhaseFetchMaximumPhaseDiscontinuityArray
• RFmxLTE_SlotPhaseFetchSamplePhaseError
• RFmxLTE_SlotPhaseFetchSamplePhaseErrorLinearFitTrace

RFmxLTE_SlotPhaseFetchPhaseDiscontinuities

int32 __stdcall RFmxLTE_SlotPhaseFetchPhaseDiscontinuities (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 slotPhaseDiscontinuity[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the array of phase differences at slot boundaries within measurement interval.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString	char[]	Specifies a selector string) comprising of the signal name and the 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. Example: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) function to build the selector string.
timeout	float64	Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize	int32	Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name	Type	Description
slotPhaseDiscontinuity	float64[]	Returns the array of phase differences at the slot boundaries within the RFMXLTE_ATTR_SLOTPHASE_MEASUREMENT_LENGTH). This value is expressed in degrees.
actualArraySize	int32*	Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 RFmxLTE_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxLTE_SlotPhaseFetchMaximumPhaseDiscontinuity

int32 __stdcall RFmxLTE_SlotPhaseFetchMaximumPhaseDiscontinuity (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* maximumPhaseDiscontinuity);

Purpose

Fetches the maximum value of phase differences at slot boundaries within the measurement interval. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to read results from this function.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString	char[]	Specifies a selector string) comprising of the signal name, result name, subblock number, and carrier number. 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. Example: "subblock0/carrier0" "signal::sig1/subblock0/carrier0" "result::r1/subblock0/carrier0" "signal::sig1/result::r1/subblock0/carrier0" You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
timeout	float64	Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name	Type	Description
maximumPhaseDiscontinuity	float64*	Returns the maximum value of phase difference at the slot boundaries within the RFMXLTE_ATTR_SLOTPHASE_MEASUREMENT_LENGTH).

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 RFmxLTE_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxLTE_SlotPhaseFetchMaximumPhaseDiscontinuityArray

int32 __stdcall RFmxLTE_SlotPhaseFetchMaximumPhaseDiscontinuityArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 maximumPhaseDiscontinuity[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the array of maximum values of phase differences at slot boundaries within the measurement interval. Use "subblock<n>" as the selector string to read results from this function.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString	char[]	Specifies a selector string) comprising of the signal name, result name, and subblock number. 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. Example: "subblock0" "signal::sig1/subblock0" "result::r1/subblock0" "signal::sig1/result::r1/subblock0" You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
timeout	float64	Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize	int32	Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name	Type	Description
maximumPhaseDiscontinuity	float64[]	Returns the array of maximum values of phase difference at the slot boundaries within the RFMXLTE_ATTR_SLOTPHASE_MEASUREMENT_LENGTH).
actualArraySize	int32*	Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 RFmxLTE_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxLTE_SlotPhaseFetchSamplePhaseError

int32 __stdcall RFmxLTE_SlotPhaseFetchSamplePhaseError (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 samplePhaseError[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the sample phase error trace for the SlotPhase measurement. At each sample, this is the phase difference between received signal and locally generated reference signal.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString	char[]	Specifies a selector string) comprising of the signal name and the 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. Example: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) function to build the selector string.
timeout	float64	Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize	int32	Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name	Type	Description
x0	float64*	Returns the start sample phase error linear fit trace value.
dx	float64*	Returns the spacing between the sample phase error linear fit trace values.
samplePhaseError	float32[]	Returns the array of sample phase error traces.
actualArraySize	int32*	Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 RFmxLTE_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxLTE_SlotPhaseFetchSamplePhaseErrorLinearFitTrace

int32 __stdcall RFmxLTE_SlotPhaseFetchSamplePhaseErrorLinearFitTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 samplePhaseErrorLinearFit[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the sample phase error linear fit trace for the SlotPhase measurement. The linear fit is over the array of phase differences at each sample between the received signal and the locally generated reference signal.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString	char[]	Specifies a selector string) comprising of the signal name and the 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. Example: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) function to build the selector string.
timeout	float64	Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize	int32	Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name	Type	Description
x0	float64*	Returns the start sample phase error linear fit trace value. This value is expressed in degrees.
dx	float64*	Returns the spacing between the sample phase error linear fit trace values.
samplePhaseErrorLinearFit	float32[]	Returns the array of sample phase error linear fit traces.
actualArraySize	int32*	Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 RFmxLTE_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors