Skip to content

NI FGEN Inherent Ivi Attributes

Jump to bottom
Palash Khare edited this page Jun 4, 2021 · 4 revisions

Inherent IVI Attributes

NIFGEN_ATTRIBUTE_DRIVER_SETUP

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050007 ViString R/W N/A None None

Description

Specifies the driver setup string portion of the option string that was passed into the niFgen_InitWithOptions function.

NIFGEN_ATTRIBUTE_LOGICAL_NAME

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050305 ViString RO N/A None None

Description

Returns a string containing the logical name that you specified when opening the current IVI session.

You may pass a logical name to the niFgen_init function or the niFgen_InitWithOptions function. The IVI Configuration Utility must contain an entry for the logical name. The logical name entry refers to a virtual instrument section in the IVI Configuration file. The virtual instrument section specifies a physical device and initial user options.

NIFGEN_ATTRIBUTE_IO_RESOURCE_DESCRIPTOR

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050304 ViString RO N/A None None

Description

Indicates the resource descriptor that NI-FGEN uses to identify the physical device.

If you initialize NI-FGEN with a logical name, this attribute contains the resource descriptor that corresponds to the entry in the IVI Configuration Utility.

If you initialize NI-FGEN with the resource descriptor, this attribute contains that value.

NIFGEN_ATTRIBUTE_CHANNEL_COUNT

IviFgenBase Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050203 ViInt32 RO N/A None None

Description

Returns the number of channels that the specific instrument driver supports. For each attribute for which IVI_VAL_MULTI_CHANNEL is set, the IVI Engine maintains a separate cache value for each channel.

NIFGEN_ATTRIBUTE_GROUP_CAPABILITIES

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050401 ViString RO N/A None None

Description

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

NIFGEN_ATTRIBUTE_SUPPORTED_INSTRUMENT_MODELS

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050327 ViString RO N/A None None

Description

Returns a model code of the device. For NI-FGEN versions that support more than one device, this attribute contains a comma-separated list of supported device models.

NIFGEN_ATTRIBUTE_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050515 ViInt32 RO N/A None None

Description

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

NIFGEN_ATTRIBUTE_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050516 ViInt32 RO N/A None None

Description

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

NIFGEN_ATTRIBUTE_SPECIFIC_DRIVER_DESCRIPTION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050514 ViString RO N/A None None

Description

Returns a brief description of the specific driver.

NIFGEN_ATTRIBUTE_SPECIFIC_DRIVER_PREFIX

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050302 ViString RO N/A None None

Description

Returns a string that contains the prefix for NI-FGEN. The name of each user-callable function in NI-FGEN starts with this prefix.

NIFGEN_ATTRIBUTE_SPECIFIC_DRIVER_VENDOR

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050513 ViString RO N/A None None

Description

Returns a string that contains the name of the vendor that supplies NI-FGEN.

NIFGEN_ATTRIBUTE_SPECIFIC_DRIVER_REVISION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050551 ViString RO N/A None None

Description

Returns a string that contains additional version information about NI-FGEN.

NIFGEN_ATTRIBUTE_INSTRUMENT_MANUFACTURER

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050511 ViString RO N/A None None

Description

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

NIFGEN_ATTRIBUTE_INSTRUMENT_MODEL

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050512 ViString RO N/A None None

Description

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

NIFGEN_ATTRIBUTE_INSTRUMENT_FIRMWARE_REVISION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050510 ViString RO N/A None None

Description

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

NIFGEN_ATTRIBUTE_MODULE_REVISION

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150390 ViString RO N/A None None

Description

Returns the revision letter of the module you are using.

NIFGEN_ATTRIBUTE_CACHE

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050004 ViBoolean R/W N/A None None

Description

Specifies whether to cache the value of attributes. When caching is enabled, NI-FGEN keeps track of the current device settings and avoids sending redundant commands to the device. Thus, you can significantly increase execution speed.

NI-FGEN can choose to always cache or to never cache particular attributes regardless of the setting of this attribute. Use the niFgen_InitWithOptions function to override the default value.

Defined Values

VI_TRUE Caching is enabled.
VI_FALSE Caching is disabled.

Default Value: VI_TRUE

NIFGEN_ATTRIBUTE_INTERCHANGE_CHECK

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050021 ViBoolean R/W N/A None None

Description

Specifies whether to perform interchangeability checking and retrieve interchangeability warnings when you call the niFgen_InitiateGeneration function.

Interchangeability warnings indicate that using your application with a different device might cause different behavior. Call the niFgen_GetNextInterchangeWarning function to extract interchange warnings. Call the niFgen_ClearInterchangeWarnings function to clear the list of interchangeability warnings without reading them.

Interchangeability checking examines the attributes in a capability group only if you specify a value for at least one attribute within that group. Interchangeability warnings can occur when an attribute affects the behavior of the device and you have not set that attribute, or the attribute has been invalidated since you set it.

Defined Values

VI_TRUE The signal generator performs interchangeability checking.
VI_FALSE The signal generators does not perform interchangeability checking.

Default Value: VI_FALSE

NIFGEN_ATTRIBUTE_QUERY_INSTRUMENT_STATUS

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050003 ViBoolean R/W N/A None None

Description

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

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

Use the niFgen_InitWithOptions function to override the default value.

Defined Values

VI_TRUE Enables NI-FGEN device status queries.
VI_FALSE Disables NI-FGEN device status queries.

Default Value: VI_TRUE

NIFGEN_ATTRIBUTE_RANGE_CHECK

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050002 ViBoolean R/W N/A None None

Description

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

Use the niFgen_InitWithOptions function to override the default value.

Defined Values

VI_TRUE Enables range checking.
VI_FALSE Disables range checking.

Default Value: VI_TRUE

NIFGEN_ATTRIBUTE_RECORD_COERCIONS

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050006 ViBoolean R/W N/A None None

Description

Specifies whether the IVI Engine keeps a list of the value coercions it makes for ViInt32 and ViReal64 attributes. Call the niFgen_GetNextCoercionRecord function to extract and delete the oldest coercion record from the list.

Use the niFgen_InitWithOptions function to override the default value.

Defined Values

VI_TRUE The IVI Engine keeps a list of value coercions.
VI_FALSE The IVI Engine does not keep a list of value coercions.

Default Value: VI_FALSE

NIFGEN_ATTRIBUTE_SIMULATE

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1050005 ViBoolean R/W N/A None None

Description

Specifies whether to simulate NI-FGEN I/O operations. If simulation is enabled, NI-FGEN functions perform range checking and call Get Attribute and Set Attribute functions, but they do not perform device I/O. For output parameters that represent device data, NI-FGEN functions return calculated values.

Use the niFgen_InitWithOptions function to override the default value.

Defined Values

VI_TRUE NI-FGEN simulates I/O operations.
VI_FALSE NI-FGEN does not simulate I/O operations.

Default Value: VI_FALSE

Table of Contents

Home

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