Returns the symbol indices that were identified to have a transient period.

Syntax

int32 __stdcall RFmxNR_ModAccFetchTransientPeriodLocationsTrace(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *x0, float64 *dx, float32 transientPeriodLocations[], int32 arraySize, int32 *actualArraySize)

Remarks

Use "carrier<k>" or "subblock<n>" or "subblock<n>/carrier<k>" as the selector string to read results from this function.

The length of the trace is equal to the number of symbols within the measurement length.

The trace returns a 1 for the symbol index that was identified to have a transient period; otherwise returns a 0.

The trace is intended to be used as additional context information for the following traces:

  • RMS EVM per Symbol Mean Trace

  • RMS EVM-High per Symbol Mean Trace

  • RMS EVM-Low per Symbol Mean Trace

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function.

selectorString[in]char

This parameter 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. The default value is "subblock0/carrier0".
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
"result::r1/subblock0/carrier0"
"signal::sig1/result::r1/subblock0/carrier0"
You can use the RFmxNR Build Carrier String function to build the selector string.

timeout[in]float64

This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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. The default value is 10.

x0[out]float64 *

This parameter returns the start symbol index from the frame start.

dx[out]float64 *

This parameter returns the width in terms of symbols.

transientPeriodLocations[out]float32

This parameter returns the symbol indices that were identified to have a transient period.

arraySize[in]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.

actualArraySize[out]int32 *

Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Returns

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 RFmxNR_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors