Skip to content

NI RFSA Inherent IVI Properties Attributes

Greg Stoll edited this page Nov 11, 2021 · 1 revision

Inherent IVI Properties Attributes

User Options

NIRFSA_ATTR_CACHE

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether to cache the value of attributes. If you set this attribute to VI_TRUE, NI-RFSA tracks the current NI-RFSA device settings and avoids sending redundant commands to the device.

NI-RFSA can always cache or never cache particular attributes, regardless of the setting of this attribute.

Use the niRFSA_InitWithOptions function to override the default value.

Defined Values:

VI_TRUE Caching is enabled.
VI_FALSE Caching is disabled.
Default Value: VI_TRUE

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_INTERCHANGE_CHECK

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether to perform interchangeability checking and retrieve interchangeability warnings.

Note  Interchangeability check is unsupported.
Defined Values:
VI_TRUE NI-RFSA performs interchangeability-checking and retrieves warnings.
VI_FALSE NI-RFSA does not perform interchangeability-checking or retrieve warnings.
Default Value: VI_FALSE

Supported Devices: None

NIRFSA_ATTR_DRIVER_SETUP

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

The Driver Setup string returns the initial values for properties that are specific to NI-RFSA.

The Driver Setup string uses the following format:

DriverSetup=*Tag:Value

Tag* is the name of the Driver Setup string attribute. Value is the value set to the attribute. If multiple attributes are set, their assignments are separated with a semicolon.

This attribute only returns the Driver Setup string that has already been defined. Refer to Driver Setup Options for more information about configuring the Driver Setup string. Refer to the niRFSA_InitWithOptions function for additional information about using the option string parameter.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_QUERY_INSTRUMENT_STATUS

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether NI-RFSA queries the NI-RFSA device status after each operation. Querying the device status is useful for debugging. After you validate your program, you can set this attribute to VI_FALSE to disable status checking and maximize performance.

NI-RFSA can choose to ignore status checking for particular attributes regardless of the setting of this attribute.

Note  Use the niRFSA_InitWithOptions function to override this value.
Defined Values:
VI_TRUE NI-RFSA queries the device status after each operation.
VI_FALSE NI-RFSA does not query the device status after each operation.
Default Value: VI_FALSE

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_RANGE_CHECK

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether to validate attribute values and function parameters. If enabled, NI-RFSA validates the parameter values that you pass to NI-RFSA functions. Range checking parameters is very useful for debugging. After you validate your program, you can set this attribute to VI_FALSE to disable range checking and maximize performance.

Note  Use the niRFSA_InitWithOptions function to override this value.
Defined Values:
VI_TRUE NI-RFSA validates attribute values and function parameters.
VI_FALSE NI-RFSA does not validate attribute values and function parameters.
Default Value: VI_TRUE

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_RECORD_COERCIONS

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type attributes.

Note  This attribute is currently not supported.
Defined Values:
VI_TRUE The IVI engine keeps a list of the value coercions.
VI_FALSE The IVI engine does not keep a list of the value coercions.
Default Value: VI_FALSE

Supported Devices: None

NIRFSA_ATTR_SIMULATE

Specific Attribute

Data
type
Access High Level Functions
ViBoolean RO None

Description

Specifies whether NI-RFSA simulates I/O operations. This attribute is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the niRFSA_InitWithOptions function to enable simulation.

Note Note  PXI-5600/5661 support setting this attribute to VI_FALSE only.
Defined Values:
VI_TRUE NI-RFSA simulates NI-RFSA I/O operations.
VI_FALSE NI-RFSA does not support simulated NI-RFSA I/O operations.
Default Value: VI_FALSE

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode); PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Driver Identification

NIRFSA_ATTR_SPECIFIC_DRIVER_DESCRIPTION

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains a brief description of NI-RFSA. This attribute returns RF Signal Analyzer Instrument Driver.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_SPECIFIC_DRIVER_PREFIX

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains the prefix for NI-RFSA. The name of each user-callable function in NI-RFSA starts with this prefix. This attribute returns niRFSA.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_SPECIFIC_DRIVER_VENDOR

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains the name of the vendor that supplies NI-RFSA. This attribute returns National Instruments.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_SPECIFIC_DRIVER_REVISION

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains additional version information about NI-RFSA. For example, NI-RFSA can return Driver: NI-RFSA 2.6, Compiler: MSVC 7.10, Components: IVI Engine 4.00, VISA-Spec 4.00 as the value of this attribute.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Driver Capabilities

NIRFSA_ATTR_SUPPORTED_INSTRUMENT_MODELS

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a comma-separated list of supported devices.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Instrument Identification

NIRFSA_ATTR_INSTRUMENT_MANUFACTURER

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains the name of the manufacturer for the NI-RFSA device you are currently using.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_INSTRUMENT_MODEL

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains the model number or name of the NI-RFSA device that you are currently using.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_INSTRUMENT_FIRMWARE_REVISION

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a string that contains the firmware revision information for the NI-RFSA downconverter for the composite device you are currently using.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Advanced Session Information

NIRFSA_ATTR_LOGICAL_NAME

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Contains the logical name you specified when opening the current IVI session. You may pass a logical name to the niRFSA_init function or the niRFSA_InitWithOptions function. The IVI Configuration Utility must contain an entry for the logical name. The logical name entry refers to a driver session section in the IVI Configuration file. The driver session section specifies a physical device and initial user options.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_IO_RESOURCE_DESCRIPTOR

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Indicates the resource name NI-RFSA uses to identify the physical device. If you initialize NI-RFSA with a logical name, this attribute contains the resource name that corresponds to the entry in the IVI Configuration Utility.

If you initialize NI-RFSA with the resource name, this attribute contains that value.

Default Value: N/A

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally