NI RFmx WLAN Fetch Powerramp Functions

Fetch PowerRamp Functions

• RFmxWLAN_PowerRampFetchMeasurement
• RFmxWLAN_PowerRampFetchRiseTrace
• RFmxWLAN_PowerRampFetchFallTrace

RFmxWLAN_PowerRampFetchMeasurement

int32 __stdcall RFmxWLAN_PowerRampFetchMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* riseTimeMean, float64* fallTimeMean);

Purpose

Returns the PowerRamp rise time and fall time.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_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. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
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
riseTimeMean	float64*	Returns the rise time of the acquired signal that is the amount of time taken for the power envelope to rise from a level of 10 percent to 90 percent. This value is expressed in seconds. When you set the RFMXWLAN_ATTR_POWERRAMP_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_POWERRAMP_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the rise time computed for each averaging count. This value is expressed in seconds.
fallTimeMean	float64*	Returns the fall time of the acquired signal that is the amount of time taken for the power envelope to fall from a level of 90 percent to 10 percent. This value is expressed in seconds. When you set the RFMXWLAN_ATTR_POWERRAMP_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_POWERRAMP_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the fall time computed for each averaging count. This value is expressed in seconds.

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

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxWLAN_PowerRampFetchRiseTrace

int32 __stdcall RFmxWLAN_PowerRampFetchRiseTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 rawWaveform[], float32 processedWaveform[], float32 threshold[], float32 powerReference[], int32 arraySize, int32* actualArraySize);

Purpose

Returns the raw, processed, threshold and power-reference traces at the beginning of a burst.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_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. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
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 trace start time. This value is expressed in seconds.
dx	float64*	Returns the sampling interval. This value is expressed in seconds.
rawWaveform	float32[]	Returns an array of measured signal power. This value is expressed as a percentage.
processedWaveform	float32[]	Returns an array of measured envelope power. This value is expressed as a percentage.
threshold	float32[]	Returns an array of threshold values. This value is expressed as a percentage.
powerReference	float32[]	Returns an array of power reference values. This value is expressed as a percentage.
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxWLAN_PowerRampFetchFallTrace

int32 __stdcall RFmxWLAN_PowerRampFetchFallTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 rawWaveform[], float32 processedWaveform[], float32 threshold[], float32 powerReference[], int32 arraySize, int32* actualArraySize);

Purpose

Returns the raw, processed, thresholding and power reference waveforms at the end of a burst.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_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. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
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 trace start time. This value is expressed in seconds.
dx	float64*	Returns the sampling interval. This value is expressed in seconds.
rawWaveform	float32[]	Returns an array of measured signal power. This value is expressed as a percentage.
processedWaveform	float32[]	Returns an array of measured envelope power. This value is expressed as a percentage.
threshold	float32[]	Returns an array of threshold values. This value is expressed as a percentage.
powerReference	float32[]	Returns an array of power reference values. This value is expressed as a percentage.
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors