NI SWITCH IVI Attributes - ni/grpc-device GitHub Wiki
IVI Attributes
- NISWITCH_ATTRIBUTE_QUERY_INSTRUMENT_STATUS
- NISWITCH_ATTRIBUTE_INTERCHANGE_CHECK
- NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_VENDOR
- NISWITCH_ATTRIBUTE_LOGICAL_NAME
- NISWITCH_ATTRIBUTE_GROUP_CAPABILITIES
- NISWITCH_ATTRIBUTE_SIMULATE
- NISWITCH_ATTRIBUTE_RECORD_COERCIONS
- NISWITCH_ATTRIBUTE_DRIVER_SETUP
- NISWITCH_ATTRIBUTE_INSTRUMENT_MODEL
- NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION
- NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_DESCRIPTION
- NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_PREFIX
- NISWITCH_ATTRIBUTE_RANGE_CHECK
- NISWITCH_ATTRIBUTE_INSTRUMENT_FIRMWARE_REVISION
- NISWITCH_ATTRIBUTE_CACHE
- NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION
- NISWITCH_ATTRIBUTE_CHANNEL_COUNT
- NISWITCH_ATTRIBUTE_SUPPORTED_INSTRUMENT_MODELS
- NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_REVISION
- NISWITCH_ATTRIBUTE_IO_RESOURCE_DESCRIPTOR
- NISWITCH_ATTRIBUTE_INSTRUMENT_MANUFACTURER
NISWITCH_ATTRIBUTE_DRIVER_SETUP
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050007 | ViString | RO | N/A | None | None |
Description
This attribute indicates the Driver Setup string that the user specified when initializing the driver.
Some cases exist where the end-user must specify instrument driver options at initialization time. An example of this is specifying a particular instrument model from among a family of instruments that the driver supports. This is useful when using simulation. The end-user can specify driver-specific options through the DriverSetup keyword in the optionString parameter to the niSwitch_InitWithOptions function, or through the IVI Configuration Utility.
If the user does not specify a Driver Setup string, this attribute returns an empty string.
Related Information
- niSwitch_InitWithOptions
- niSwitch Properties
NISWITCH_ATTRIBUTE_IO_RESOURCE_DESCRIPTOR
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050304 | ViString | RO | N/A | None | None |
Description
Indicates the resource descriptor the driver uses to identify the physical device. If you initialize the driver with a logical name, this attribute contains the resource descriptor that corresponds to the entry in the IVI Configuration utility. If you initialize the instrument driver with the resource descriptor, this attribute contains that value.
Related Information
- Initialization
- niSwitch Properties
NISWITCH_ATTRIBUTE_LOGICAL_NAME
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050305 | ViString | RO | N/A | None | None |
Description
A string containing the logical name you specified when opening the current IVI session. You may pass a logical name to the niSwitch_init or niSwitch_InitWithOptions functions. 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.
Related Information
- Initialization
- niSwitch Properties
- Using NI Switches in IVI
NISWITCH_ATTRIBUTE_CHANNEL_COUNT
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050203 | ViInt32 | RO | N/A | None | None |
Description
Indicates the number of channels that the specific instrument driver supports.
Related Information
- niSwitch_GetChannelName
- niSwitch Properties
NISWITCH_ATTRIBUTE_GROUP_CAPABILITIES
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050401 | ViString | RO | N/A | None | None |
Description
A string that contains a comma-separated list of class-extension groups that this driver implements.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SUPPORTED_INSTRUMENT_MODELS
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050327 | ViString | RO | N/A | None | None |
Description
Contains a comma-separated list of supported instrument models.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050515 | ViInt32 | RO | N/A | None | None |
Description
The major version number of the IviSwtch class specification.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050516 | ViInt32 | RO | N/A | None | None |
Description
The minor version number of the class specification with which this driver is compliant.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_DESCRIPTION
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050514 | ViString | RO | N/A | None | None |
Description
A string that contains a brief description of the specific driver.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_PREFIX
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050302 | ViString | RO | N/A | None | None |
Description
A string that contains the prefix for the instrument driver. The name of each user-callable function in this driver starts with this prefix.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_VENDOR
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050513 | ViString | RO | N/A | None | None |
Description
A string that contains the name of the vendor that supplies this driver.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_SPECIFIC_DRIVER_REVISION
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050551 | ViString | RO | N/A | None | None |
Description
A string that contains additional version information about this instrument driver.
Related Information
- niSwitch Properties
- niSwitch_revision_query
NISWITCH_ATTRIBUTE_INSTRUMENT_FIRMWARE_REVISION
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050510 | ViString | RO | N/A | None | None |
Description
A string that contains the firmware revision information for the instrument you are currently using.
Related Information
- niSwitch Properties
- niSwitch_revision_query
NISWITCH_ATTRIBUTE_INSTRUMENT_MANUFACTURER
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050511 | ViString | RO | N/A | None | None |
Description
A string that contains the name of the instrument manufacturer you are currently using.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_INSTRUMENT_MODEL
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050512 | ViString | RO | N/A | None | None |
Description
A string that contains the model number or name of the instrument that you are currently using.
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_CACHE
Specific Attribute
Numeric Value | Datatype | 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, the instrument driver keeps track of the current instrument settings and avoids sending redundant commands to the instrument. The instrument driver can choose always to cache or never to cache particular attributes regardless of the setting of this attribute. The default value is VI_TRUE. Use the niSwitch_InitWithOptions function to override this value.
Defined Values:
VI_TRUE
VI_FALSE
Related Information
- niSwitch_InitWithOptions
- niSwitch Properties
NISWITCH_ATTRIBUTE_INTERCHANGE_CHECK
Specific Attribute
Numeric Value | Datatype | 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 niSwitch_Connect, niSwitch_SetPath and niSwitch_InitiateScan functions.
The default value is VI_FALSE.
Interchangeability warnings indicate that using your application with a different instrument might cause different behavior. call niSwitch_GetNextInterchangeWarning to extract interchange warnings. Call the niSwitch_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 instrument and you have not set that attribute, or the attribute has been invalidated since you set it.
Defined Values:
VI_TRUE
VI_FALSE
Related Information
- niSwitch_GetNextInterchangeWarning
- niSwitch Properties
- niSwitch_ResetInterchangeCheck
NISWITCH_ATTRIBUTE_QUERY_INSTRUMENT_STATUS
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050003 | ViBoolean | R/W | N/A | None | None |
Description
Specifies whether the instrument driver queries the instrument status after each operation. Querying the instrument 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 The instrument driver can choose to ignore status checking for particular attributes regardless of the setting of this attribute. The default value is VI_TRUE. Use the niSwitch_InitWithOptions function to override this value.
Defined Values:
VI_TRUE
VI_FALSE
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_RANGE_CHECK
Specific Attribute
Numeric Value | Datatype | 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, the instrument driver validates the parameter values that you pass to driver 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. The default value is VI_TRUE. Use the niSwitch_InitWithOptions function to override this value.
Defined Values:
VI_TRUE
VI_FALSE
Related Information
- niSwitch Properties
NISWITCH_ATTRIBUTE_RECORD_COERCIONS
Specific Attribute
Numeric Value | Datatype | 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 niSwitch_GetNextCoercionRecord to extract and delete the oldest coercion record from the list. The default value is VI_FALSE. Use the niSwitch_InitWithOptions function to override this value.
Defined Values:
VI_TRUE
VI_FALSE
Related Information
- niSwitch_GetNextCoercionRecord
- niSwitch Properties
NISWITCH_ATTRIBUTE_SIMULATE
Specific Attribute
Numeric Value | Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|---|
1050005 | ViBoolean | R/W | N/A | None | None |
Description
Specifies whether or not to simulate instrument driver I/O operations. If simulation is enabled, instrument driver functions perform range checking and call Ivi_GetAttribute and Ivi_SetAttribute functions, but they do not perform instrument I/O. For output parameters that represent instrument data, the instrument driver functions return calculated values. The default value is VI_FALSE. Use the niSwitch_InitWithOptions function to override this value.
Defined Values:
VI_TRUE
VI_FALSE
Related Information
- niSwitch_InitWithOptions
- niSwitch Properties
- Simulating a Switch