NI RFmx SpecAn Utility Functions

Utility Functions

• RFmxSpecAn_Commit
• RFmxSpecAn_ResetToDefault
• RFmxSpecAn_InitializeFromNIRFSASession
• RFmxSpecAn_WaitForAcquisitionComplete
• RFmxSpecAn_WaitForMeasurementComplete
• RFmxSpecAn_CheckMeasurementStatus
• RFmxSpecAn_ResetAttribute

RFmxSpecAn_Commit

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

Purpose

Commits settings to the hardware. Calling this function is optional. RFmxSpecAn commits settings to the hardware when you call the RFmxSpecAn_Initiate) function or any of the measurement Read functions.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_ResetToDefault

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

Purpose

Resets a signal to the default values.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" You can use the RFmxSpecAn_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 RFmxSpecAn_GetError) function. The general meaning of the status code is as follows:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_InitializeFromNIRFSASession

int32 __stdcall RFmxSpecAn_InitializeFromNIRFSASession (uInt32 NIRFSASession, niRFmxInstrHandle *handleOut);

Purpose

Creates an RFmx session from an existing NI-RFSA session. This function resets all the NI-RFSA attributes to their default values and stops export of all external signals and events. This function takes in an active NI-RFSA instrument handle and returns an RFmx Handle Out that identifies the device in all the subsequent RFmx functions.

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_InitializeFromNIRFSASession) function.

Parameters

Input
Name	Type	Description
NIRFSASession	uInt32	Specifies the NIRFSA session handle of the device to initialize.
Output
Name	Type	Description
handleOut	niRFmxInstrHandle*	Returns an RFmx instrument session.

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

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_WaitForAcquisitionComplete

int32 __stdcall RFmxSpecAn_WaitForAcquisitionComplete (niRFmxInstrHandle instrumentHandle, float64 timeout);

Purpose

Waits and blocks the data flow until the acquisition is done. This function is typically called after the specific Initiate function.

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_WaitForAcquisitionComplete) function.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
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.

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

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_WaitForMeasurementComplete

int32 __stdcall RFmxSpecAn_WaitForMeasurementComplete (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout);

Purpose

Waits for the specified number of seconds for all the measurements to complete.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxSpecAn_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.

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

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_CheckMeasurementStatus

int32 __stdcall RFmxSpecAn_CheckMeasurementStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 *isDone);

Purpose

Checks the status of the measurement. Use this function to check for any errors that may occur during measurement or to check whether the measurement is complete and results are available.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used. Example: "" "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxSpecAn_BuildSignalString )function to build the selector string).
Output
Name	Type	Description
isDone	int32*	Indicates whether the measurement is complete.

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

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

RFmxSpecAn_ResetAttribute

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

Purpose

Resets an attribute that you specify in the attributeID parameter to default values.

Parameters

Input
Name	Type	Description
instrumentHandle	niRFmxInstrHandle	Identifies the RFmx session. You can obtain this parameter from the RFmxSpecAn_Initialize) function.
selectorString	char[]	Specifies the selector string for the attribute being reset. Refer to the Selector String (C or LabWindows/CVI)) topic for more information about configuring the selector string.
attributeID	int32	Pass the ID of an attribute.

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

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors