NI RFmx WLAN Advanced Functions

Advanced Functions

• RFmxWLAN_AbortMeasurements
• Analyze
  • RFmxWLAN_AnalyzeIQ1Waveform
  • RFmxWLAN_AnalyzeSpectrum1Waveform
  • RFmxWLAN_AnalyzeNWaveformsIQ
  • RFmxWLAN_AnalyzeNWaveformsSpectrum
• RFmxWLAN_CreateSignalConfiguration
• RFmxWLAN_CloneSignalConfiguration
• RFmxWLAN_DeleteSignalConfiguration
• RFmxWLAN_GetAllNamedResultNames
• RFmxWLAN_ClearNamedResult
• RFmxWLAN_ClearAllNamedResults

RFmxWLAN_AbortMeasurements

int32 __stdcall RFmxWLAN_AbortMeasurements (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Stops acquisition and measurements associated with signal instance that you specify in the selectorString parameter, which were previously initiated by the RFmxWLAN_Initiate function or measurement read functions. Calling this function is optional, unless you want to stop a measurement before it is complete. This function executes even if there is an incoming error.

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. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxWLAN_BuildSignalString function to build the selector string.

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

Analyze

RFmxWLAN_AnalyzeIQ1Waveform

int32 __stdcall RFmxWLAN_AnalyzeIQ1Waveform (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultName[], float64 x0, float64 dx, NIComplexSingle IQ[], int32 arraySize, int32 reset, int64 reserved);

Purpose

Performs the enabled measurements on the I/Q complex waveform that you specify in IQ parameter. Call this function after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch functions or result attributes in the attribute node. Use this function only if the Recommended Acquisition Type attribute value is either IQ or IQorSpectral. When using the Analysis-Only mode in RFmxWLAN, the RFmx driver ignores the RFmx hardware settings such as reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and trigger type, since it is needed for spectral measurement traces as well as some measurements such as ModAcc, ACP, and SEM.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the RFmx session refnum. instrumentHandle is obtained from the RFmxInstr_InitializeNIRFSA function or the RFmxInstr_InitializeNIRFSAArray function.
selectorString	char[]	Specifies the signal name and result name. The result name can either be specified through this input or the resultName parameter. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name in this parameter, either the result name specified by the resultName parameter or the default result instance is used. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
resultName	char[]	Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix. Example: "result::r1" "r1"
x0	float64	Specifies the start time of the input y array. This value is expressed in seconds.
dx	float64	Specifies the time interval between the samples in the input y array. This value is expressed in seconds. The reciprocal of dx indicates the I/Q rate of the input signal.
IQ	NIComplexSingle[]	Specifies an array of complex-valued time domain data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.
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.
reset	int32	Resets measurement averaging. If you enable averaging, set this parameter to TRUE for first record and FALSE for subsequent records.
reserved	int64	Reserved for future use. Any value passed to this parameter will be ignored.

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_AnalyzeSpectrum1Waveform

int32 __stdcall RFmxWLAN_AnalyzeSpectrum1Waveform (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultName[], float64 x0, float64 dx, float32 spectrum[], int32 arraySize, int32 reset, int64 reserved);

Purpose

Performs the enabled measurements on the spectrum that you specify in the spectrum parameter. Call this function after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch functions or result attributes in the attribute node. Use this function only if the Recommended Acquisition Type attribute value is either spectral or IQorSpectral.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the RFmx session refnum. instrumentHandle is obtained from the RFmxInstr_InitializeNIRFSA function or the RFmxInstr_InitializeNIRFSAArray function.
selectorString	char[]	Specifies the signal name and result name. The result name can either be specified through this input or the resultName parameter. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name in this parameter, either the result name specified by the resultName parameter or the default result instance is used. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
resultName	char[]	Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix. Example: "result::r1" "r1"
x0	float64	Specifies the start frequency of the spectrum. This value is expressed in Hz.
dx	float64	Specifies the frequency interval between data points in the spectrum.
spectrum	float32[]	Specifies the array of real-value power spectrum.
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.
reset	int32	Resets measurement averaging. If you enable averaging, set this parameter to TRUE for first record and FALSE for subsequent records.
reserved	int64	Reserved for future use. Any value passed to this parameter will be ignored.

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_AnalyzeNWaveformsIQ

int32 __stdcall RFmxWLAN_AnalyzeNWaveformsIQ (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultName[], float64 x0[], float64 dx[], NIComplexSingle IQ[], int32 IQSize[], int32 arraySize, int32 reset);

Purpose

Performs the enabled measurements on the I/Q complex waveform(s) that you specify in IQ parameter. Call this function after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch functions or result attributes in the attribute node. Use this function only if the Recommended Acquisition Type attribute value is either IQ or IQorSpectral. When using the Analysis-Only mode in RFmxWLAN, the RFmx driver ignores the RFmx hardware settings such as reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and trigger type, since it is needed for spectral measurement traces as well as some measurements such as ModAcc, ACP, and SEM. Note: Query the Recommended Acquisition Type attribute from the RFmxInstr Property Node after calling the RFmx WLAN Commit function.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the RFmx session refnum. instrumentHandle is obtained from the RFmxInstr_Initialize function.
selectorString	char[]	Specifies the signal name and result name. The result name can either be specified through this input or the resultName parameter. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name in this parameter, either the result name specified by the resultName parameter or the default result instance is used. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
resultName	char[]	Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix. Example: "result::r1" "r1"
x0	float64[]	Specifies the start time of the input y array. This value is expressed in seconds.
dx	float64[]	Specifies the time interval between the samples in the input y array. This value is expressed in seconds. The reciprocal of dx indicates the I/Q rate of the input signal.
IQ	NIComplexSingle[]	Specifies an array of complex-valued time domain data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.
IQSize	int32[]	Specifies the size of n waveforms
reset	int32	Resets measurement averaging. If you enable averaging, set this parameter to TRUE for first record and FALSE for subsequent records.
arraySize	int32	Specifies the size of the array.

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_AnalyzeNWaveformsSpectrum

int32 __stdcall RFmxWLAN_AnalyzeNWaveformsSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultName[], float64 x0[], float64 dx[], float32 spectrum[], int32 spectrumSize[], int32 arraySize, int32 reset);

Purpose

Performs the enabled measurements on the spectrum(s) that you specify in the spectrum parameter. Call this function after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch functions or result attributes in the attribute node. Use this function only if the Recommended Acquisition Type attribute value is either spectral or IQorSpectral. Note: Query the Recommended Acquisition Type attribute from the RFmxInstr Property Node after calling the RFmx WLAN Commit function.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the RFmx session refnum. instrumentHandle is obtained from the RFmxInstr_Initialize function.
selectorString	char[]	Specifies the signal name and result name. The result name can either be specified through this input or the resultName parameter. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name in this parameter, either the result name specified by the resultName parameter or the default result instance is used. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxWLAN_BuildSignalString.
resultName	char[]	Specifies the name to be associated with measurement results. Provide a unique name, such as "r1" to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the "result::" prefix. Example: "result::r1" "r1"
x0	float64[]	Specifies the start frequency of the spectrum. This value is expressed in Hz.
dx	float64[]	Specifies the frequency interval between data points in the spectrum.
spectrum	float32[]	Specifies the array of real-value power spectrum.
spectrumSize	int32[]	Specifies the size of n waveforms
reset	int32	Resets measurement averaging. If you enable averaging, set this parameter to TRUE for first record and FALSE for subsequent records.
arraySize	int32	Specifies the size of the array.

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_CreateSignalConfiguration

int32 __stdcall RFmxWLAN_CreateSignalConfiguration (niRFmxInstrHandle instrumentHandle, char signalName[]);

Purpose

Creates a new instance of a signal.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
signalName	char[]	Specifies the name of the signal. This parameter accepts the signal name with or without the "signal::" prefix. Example: "signal::s1" "sig1"

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_CloneSignalConfiguration

int32 __stdcall RFmxWLAN_CloneSignalConfiguration (niRFmxInstrHandle instrumentHandle, char oldSignalName[], char newSignalName[]);

Purpose

Creates a new instance of a signal by copying all the attribute values from an existing signal instance.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
oldSignalName	char[]	Specifies the name of an existing signal. This parameter accepts the signal name with or without the "signal::" prefix. Example: "signal::OldSigName" "OldSigName"
newSignalName	char[]	Specifies the name of the new signal. This parameter accepts the signal name with or without the "signal::" prefix. Example: "signal::NewSigName" "NewSigName"

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_DeleteSignalConfiguration

int32 __stdcall RFmxWLAN_DeleteSignalConfiguration (niRFmxInstrHandle instrumentHandle, char signalName[]);

Purpose

Deletes an instance of a signal that you specify in the signalName parameter.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
signalName	char[]	Specifies the name of the signal. This parameter accepts the signal name with or without the "signal::" prefix. Example: "signal::s1" "sig1"

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_GetAllNamedResultNames

int32 __stdcall RFmxWLAN_GetAllNamedResultNames (niRFmxInstrHandle instrumentHandle, char selectorString[], char resultNames[], int32 resultNamesBufferSize, int32* actualResultNamesSize, int32* defaultResultExists);

Purpose

Returns all the named result names of the signal that you specify in the selectorString parameter.

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. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxWLAN_BuildSignalString function to build the selector string.
resultNamesBufferSize	int32	Specifies the size of the resultNames array. Set the resultNamesBufferSize parameter to 0 to get the size of the resultNames array in the return value.
Output
Name	Type	Description
resultNames	char[]	Returns an array of result names.
actualResultNamesSize	int32*	Returns the actual size of the resultNames array, if you pass NULL to resultNames array parameter and set the resultNamesBufferSize parameter to 0.
defaultResultExists	int32*	Indicates whether the default result exists.

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_ClearNamedResult

int32 __stdcall RFmxWLAN_ClearNamedResult (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Clears a result instance specified by the result name in the selectorString parameter.

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 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 function to build the selector string.

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_ClearAllNamedResults

int32 __stdcall RFmxWLAN_ClearAllNamedResults (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Clears all results for the signal that you specify in the selectorString parameter.

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. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxWLAN_BuildSignalString function to build the selector string.

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