Skip to content

NI RFSG Inherent IVI Attributes Attributes

Greg Stoll edited this page Nov 11, 2021 · 2 revisions

Inherent IVI Attributes Attributes

Advanced Session Information

NIRFSG_ATTR_LOGICAL_NAME

Numeric Value Data
type
Access Coercion High Level Functions
1050305 ViString RO None None

Description

Returns a string that contains the logical name you specified when opening the current IVI session. You can pass a logical name to the niRFSG_init function or the niRFSG_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.

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_IO_RESOURCE_DESCRIPTOR

Numeric Value Data
type
Access Coercion High Level Functions
1050304 ViString RO None None

Description

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

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_DRIVER_SETUP

Numeric Value Data
type
Access Coercion High Level Functions
1050007 ViString RO None None

Description

Returns a string that contains the initial values for attributes that are specific to NI-RFSG.

The Driver Setup string is in the following format:

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 the niRFSG_InitWithOptions function for additional information about the optionString parameter.

Default Value: "" (empty string)

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5840/5841

Related Topics

Driver Setup Options—Refer to this topic for more information about configuring the Driver Setup string.

Driver Capabilities

NIRFSG_ATTR_GROUP_CAPABILITIES

Numeric Value Data
type
Access Coercion High Level Functions
1050401 ViString RO None None

Description

Returns a string that contains a comma-separated list of class-extension groups that NI-RFSG implements.

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SUPPORTED_INSTRUMENT_MODELS

Numeric Value Data
type
Access Coercion High Level Functions
1050327 ViString RO None None

Description

Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this attribute contains a comma-separated list of supported devices.

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Driver Identification

NIRFSG_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION

Numeric Value Data
type
Access Coercion High Level Functions
1050515 ViInt32 RO None None

Description

Returns the major version number of the class specification with which NI-RFSG is compliant.

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION

Numeric Value Data
type
Access Coercion High Level Functions
1050516 ViInt32 RO None None

Description

Returns the minor version number of the class specification with which NI-RFSG is compliant.

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SPECIFIC_DRIVER_DESCRIPTION

Numeric Value Data
type
Access Coercion High Level Functions
1050514 ViString RO None None

Description

Returns a string that contains a brief description of NI-RFSG. This attribute returns National Instruments RF Signal Generator Instrument Driver.

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SPECIFIC_DRIVER_PREFIX

Numeric Value Data
type
Access Coercion High Level Functions
1050302 ViString RO None None

Description

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

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SPECIFIC_DRIVER_VENDOR

Numeric Value Data
type
Access Coercion High Level Functions
1050513 ViString RO None None

Description

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

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SPECIFIC_DRIVER_REVISION

Numeric Value Data
type
Access Coercion High Level Functions
1050551 ViString RO None None

Description

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

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Instrument Identification

NIRFSG_ATTR_INSTRUMENT_FIRMWARE_REVISION

Numeric Value Data
type
Access Coercion High Level Functions
1050510 ViString RO None niRFSG_revision_query

Description

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

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_INSTRUMENT_MANUFACTURER

Numeric Value Data
type
Access Coercion High Level Functions
1050511 ViString RO None None

Description

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

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_INSTRUMENT_MODEL

Numeric Value Data
type
Access Coercion High Level Functions
1050512 ViString RO None None

Description

Returns a string that contains the model number or name of the NI-RFSG device that you are currently using. For drivers that support more than one device, this attribute returns a comma-separated list of supported devices.

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

User Options

NIRFSG_ATTR_CACHE

Numeric Value Data
type
Access Coercion High Level Functions
1050004 ViBoolean R/W None None

Description

Specifies whether to cache the value of attributes. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular attributes, regardless of the setting of this attribute. Call the niRFSG_InitWithOptions function to override the default value.

Defined Values:

VI_TRUE Enables caching.
VI_FALSE Disables caching.
Default Value: VI_TRUE

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_INTERCHANGE_CHECK

Numeric Value Data
type
Access Coercion High Level Functions
1050021 ViBoolean R/W None None

Description

Specifies whether to perform interchangeability checking and retrieve interchangeability warnings.

Defined Values:

VI_TRUE Interchange check is enabled.
VI_FALSE Interchange check is disabled.
Default Value: VI_FALSE
Note  Enabling interchangeability check is not supported.
Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_QUERY_INSTRUMENT_STATUS

Numeric Value Data
type
Access Coercion High Level Functions
1050003 ViBoolean R/W None None

Description

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

NI-RFSG can choose to ignore status checking for particular attributes, regardless of the setting of this attribute. Use the niRFSG_InitWithOptions function to override the default value.

Defined Values:

VI_TRUE NI-RFSG queries the instrument status after each operation.
VI_FALSE NI-RFSG does not query the instrument status.
Default Value: VI_FALSE

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_RANGE_CHECK

Numeric Value Data
type
Access Coercion High Level Functions
1050002 ViBoolean R/W None None

Description

Specifies whether to validate attribute values and function parameters. Range checking parameters is very useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular attributes, regardless of the setting of this attribute. Use the niRFSG_InitWithOptions function to override the default value.

Defined Values:

VI_TRUE Enable range checking.
VI_FALSE Disable range checking.
Default Value: VI_TRUE

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_RECORD_COERCIONS

Numeric Value Data
type
Access Coercion High Level Functions
1050006 ViBoolean R/W None None

Description

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

Defined Values:

VI_TRUE The IVI engine keeps a list of coercions.
VI_FALSE The IVI engine does not keep a list of coercions.
Default Value: VI_FALSE
Note  Enabling record value coercions is not supported.
Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_SIMULATE

Numeric Value Data
type
Access Coercion High Level Functions
1050005 ViBoolean R0 None None

Description

Returns whether NI-RFSG 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 niRFSG_InitWithOptions function to enable simulation.

Defined Values:

VI_TRUE Simulation is enabled.
VI_FALSE Simulation is disabled.
Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, 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