BoardIndex

Specify index number of interface board

Description

You configure BoardIndex to be the index number of the GPIB board, USB board, or TCP/IP board associated with your instrument. When you create a GPIB, VISA-GPIB, VISA-GPIB-VXI, VISA-TCPIP, or VISA-USB object, BoardIndex is automatically assigned the value specified in the gpib or visa function.

For GPIB objects, the Name property is automatically updated to reflect the BoardIndex value. For VISA-GPIB, VISA-GPIB-VXI, VISA-TCPIP, or VISA-USB objects, the Name and RsrcName properties are automatically updated to reflect the BoardIndex value.

You can configure BoardIndex only when the object is disconnected from the instrument. You disconnect a connected object with the fclose function. A disconnected object has a Status property value of closed.

Characteristics

Usage

GPIB, VISA-GPIB, VISA-GPIB-VXI, VISA-TCPIP, VISA-USB

Read only

While open (GPIB, VISA-GPIB), always (VISA-GPIB-VXI, VISA-TCPIP, VISA-USB)

Data type

Double

Values

The value is defined after the instrument object is created.

Examples

Suppose you create a VISA-GPIB object associated with board 4, primary address 1, and secondary address 8.

vg = visa('agilent','GPIB4::1::8::INSTR');

The BoardIndex, Name, and RsrcName properties reflect the GPIB board index number.

vg.BoardIndex
ans = 
    [4]    
vg.Name
ans = 
    'VISA-GPIB4-1-8'    
vg,.RsrcName
ans = 
		'GPIB4::1::8::INSTR'

See Also

Functions

fclose, gpib, visa

Properties

Name, RsrcName, Status

Was this topic helpful?