Statistics
| Branch: | Revision:

root / quad1 / AeroQuadConfigurator / builds / AeroQuadConfigurator / SourceDistribution / visarc @ 9240aaa3

History | View | Annotate | Download (202 KB)

1
// VISA specification version 4.0 class definitions for LabVIEW 7.x
2

    
3
// The field between readonly/readwrite and the attribute ID is a bitmask with these flags:
4
//     1L<<2    enum should include "Other..."
5
//     1L<<31   property has local scope
6

    
7
class: "VISA object"
8
flags: 3
9
sorted: no
10
  // STOP ATTRIBUTE LIST
11

    
12
  method: "VISA Close" noInvoke
13

    
14
// STOP CLASS
15

    
16
// First come all the I/O classes
17

    
18
class: "I/O Session"
19
super: "VISA object"
20
flags: 2
21
sorted: no
22
  attribute: "Queue Len"
23
    "General Settings:Maximum Queue Length"
24
    uL readwrite 80000000 3FFF0005
25
    // const: VI_ATTR_MAX_QUEUE_LENGTH
26
    "Specifies the maximum number of events that can be queued at any time on the given session. This property is read/write until the first time you call VISA Enable Event on a session. Thereafter, it is read only. The default is 50."
27
  // STOP ATTRIBUTE
28
  attribute: "Rsrc Lock State"
29
    "General Settings:Resource Lock State"
30
    uL enum {Unlocked=0, Exclusive=1, Shared=2} readonly 00000000 3FFF0004
31
    // const: VI_ATTR_RSRC_LOCK_STATE
32
    "Returns the current locking state of the resource associated with the given session. The resource can be unlocked, locked with an exclusive lock, or locked with a shared lock. The default is Unlocked."
33
  // STOP ATTRIBUTE
34
  attribute: "Rsrc Name"
35
    "General Settings:Resource Name"
36
    string readonly 00000000 BFFF0002
37
    // const: VI_ATTR_RSRC_NAME
38
    "Returns the unique identifier for a resource."
39
  // STOP ATTRIBUTE
40
  attribute: "Rsrc Class"
41
    "General Settings:Resource Class"
42
    string readonly 00000000 BFFF0001
43
    // const: VI_ATTR_RSRC_CLASS
44
    "Returns the resource class of the resource string used to open the given session.  For example, if the resource string for a given session is COM1 or ASRL1::INSTR, this property returns INSTR, regardless of the class of the I/O control."
45
  // STOP ATTRIBUTE
46
  attribute: "Timeout"
47
    "General Settings:Timeout Value"
48
    uL readwrite 80000000 3FFF001A
49
    // const: VI_ATTR_TMO_VALUE
50
    "Specifies the minimum timeout value, in milliseconds, to use when accessing the device. Note that the actual timeout that VISA returns may be higher than the one requested. The default is 2000."
51
  // STOP ATTRIBUTE
52
  attribute: "User Data"
53
    "General Settings:User Data"
54
    uL readwrite 80000000 3FFF0007
55
    // const: VI_ATTR_USER_DATA
56
    "Specifies a data value for the private use of an application. The VISA implementation stores this value in a per-session location, so that user data on other sessions does not affect the user data on this session. VISA does not use this property for any purpose."
57
  // STOP ATTRIBUTE
58
  attribute: "Intf Num"
59
    "Interface Information:Interface Number"
60
    uW readonly 00000000 3FFF0176
61
    // const: VI_ATTR_INTF_NUM
62
    "Returns the board number for the given interface."
63
  // STOP ATTRIBUTE
64
  attribute: "Intf Type"
65
    "Interface Information:Interface Type"
66
    uW enum {GPIB=1, VXI=2, GPIB-VXI=3, Serial=4, PXI=5, TCPIP=6, USB=7, FireWire=9} readonly 00000000 3FFF0171
67
    // const: VI_ATTR_INTF_TYPE
68
    "Specifies the interface type of the given session."
69
  // STOP ATTRIBUTE
70
  attribute: "Intf Inst Name"
71
    "Interface Information:Interface Description"
72
    string readonly 00000000 BFFF00E9
73
    // const: VI_ATTR_INTF_INST_NAME
74
    "Specifies human-readable text that describes the given interface.
75

    
76
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
77
  // STOP ATTRIBUTE
78
  attribute: "Impl Version"
79
    "Version Information:Version of Implementation"
80
    uL readonly 00000000 3FFF0003
81
    // const: VI_ATTR_RSRC_IMPL_VERSION
82
    "Returns the version of a given implementation. This value is defined by the individual manufacturer and increments with each new revision. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version."
83
  // STOP ATTRIBUTE
84
  attribute: "Spec Version"
85
    "Version Information:Version of Specification"
86
    uL readonly 00000000 3FFF0170
87
    // const: VI_ATTR_RSRC_SPEC_VERSION
88
    "Returns the value that uniquely identifies the version of the VISA specification to which the implementation complies. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version."
89
  // STOP ATTRIBUTE
90
  attribute: "Rsrc Manf Id"
91
    "Version Information:Resource Manufacturer Identification"
92
    uW readonly 00000000 3FFF0175
93
    // const: VI_ATTR_RSRC_MANF_ID
94
    "Returns a value that corresponds to the VXI manufacturer ID of the manufacturer that created the VISA implementation."
95
  // STOP ATTRIBUTE
96
  attribute: "Rsrc Manf Name"
97
    "Version Information:Resource Manufacturer Name"
98
    string readonly 00000000 BFFF0174
99
    // const: VI_ATTR_RSRC_MANF_NAME
100
    "Returns the name of the manufacturer that created the implementation. This is not related to the device manufacturer attributes.
101

    
102
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
103
  // STOP ATTRIBUTE
104
  // STOP ATTRIBUTE LIST
105

    
106
  method: "VISA Status Description" noInvoke
107
  method: "VISA Open" noInvoke
108
  method: "VISA Lock" noInvoke
109
  method: "VISA Unlock" noInvoke
110
  method: "VISA Enable Event" noInvoke
111
  method: "VISA Disable Event" noInvoke
112
  method: "VISA Wait on Event" noInvoke
113
  method: "VISA Discard Events" noInvoke
114

    
115
// STOP CLASS
116

    
117
// There is INSTR and its many derivations (GPIB, VXI, Serial, PXI, TCPIP)
118

    
119
class: "Instr"
120
super: "I/O Session"
121
sorted: no
122
classString: "?*::(INSTR|SOCKET)"
123
  attribute: "Manf Name"
124
    "General Settings:Manufacturer Name"
125
    string readonly 00000000 BFFF0072
126
    // const: VI_ATTR_MANF_NAME
127
    "Returns the name of the manufacturer that created the device.
128

    
129
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.
130

    
131
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI, VXI, PXI/PCI, FireWire, and USB resources."
132
  // STOP ATTRIBUTE
133
  attribute: "Model Name"
134
    "General Settings:Model Name"
135
    string readonly 00000000 BFFF0077
136
    // const: VI_ATTR_MODEL_NAME
137
    "Returns the model name of the device. 
138

    
139
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions.
140

    
141
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI, VXI, PXI/PCI, FireWire, and USB resources."
142
  // STOP ATTRIBUTE
143
  attribute: "Manf Id"
144
    "General Settings:Manufacturer Identification"
145
    uW readonly 00000000 3FFF00D9
146
    // const: VI_ATTR_MANF_ID
147
    "Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID).
148

    
149
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI, VXI, PXI/PCI, and USB resources."
150
  // STOP ATTRIBUTE
151
  attribute: "Model Code"
152
    "General Settings:Model Code"
153
    uW readonly 00000000 3FFF00DF
154
    // const: VI_ATTR_MODEL_CODE
155
    "Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID).
156

    
157
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI, VXI, PXI/PCI, and USB resources."
158
  // STOP ATTRIBUTE
159
  attribute: "Slot"
160
    "General Settings:Slot"
161
    iW readonly 00000000 3FFF00E8
162
    // const: VI_ATTR_SLOT
163
    "Returns the physical slot location of the device. If the slot is unknown, the value returned is -1.
164

    
165
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI, VXI, and PXI/PCI resources."
166
  // STOP ATTRIBUTE
167
  attribute: "Trigger Id"
168
    "General Settings:Trigger Identifier"
169
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readwrite 80000000 3FFF0177
170
    // const: VI_ATTR_TRIG_ID
171
    "Specifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software.
172

    
173
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI, VXI, and PXI resources."
174
  // STOP ATTRIBUTE
175
  attribute: "Allow DMA"
176
    "General Settings:Allow DMA Transfers"
177
    bool readwrite 80000000 3FFF001E
178
    // const: VI_ATTR_DMA_ALLOW_EN
179
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality.
180

    
181
<B>Note:</B> In the Instr class, this property is valid only for GPIB, GPIB-VXI, and VXI resources."
182
  // STOP ATTRIBUTE
183
  attribute: "TermChar"
184
    "Message Based Settings:Termination Character"
185
    uB readwrite 80000000 3FFF0018
186
    // const: VI_ATTR_TERMCHAR
187
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
188
  // STOP ATTRIBUTE
189
  attribute: "TermChar En"
190
    "Message Based Settings:Termination Character Enable"
191
    bool readwrite 80000000 3FFF0038
192
    // const: VI_ATTR_TERMCHAR_EN
193
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
194
  // STOP ATTRIBUTE
195
  attribute: "Send End En"
196
    "Message Based Settings:Send End Enable"
197
    bool readwrite 80000000 3FFF0016
198
    // const: VI_ATTR_SEND_END_EN
199
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
200

    
201
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the property End Mode for Writes (ASRL End Out).
202

    
203
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
204
  // STOP ATTRIBUTE
205
  attribute: "Suppress End En"
206
    "Message Based Settings:Suppress End Enable"
207
    bool readwrite 80000000 3FFF0036
208
    // const: VI_ATTR_SUPPRESS_END_EN
209
    "Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations.
210

    
211
For all session types that support this property, if this property is set to TRUE, read does not terminate due to an END condition. However, a read may still terminate successfully if the Message Based Settings:Termination Character Enable (TermChar En) property is set to TRUE. Otherwise, read does not terminate until it receives all of the requested data (or an error occurs). The default is FALSE (except for TCP/IP Socket sessions).
212

    
213
On Serial Instr sessions, if this property is set to FALSE, VISA performs the behavior described in the Serial Settings:End Mode for Reads (ASRL End In) property.
214

    
215
On USB Raw sessions, if this property is set to FALSE, VISA performs the behavior described in the USB Settings:End Mode for Reads (USB End In) property.
216

    
217
On TCP/IP Socket sessions, if this property is set to FALSE, if NI-VISA reads some data and then detects a pause in the arrival of data packets, it terminates the read operation. On TCP/IP Socket sessions, the default value for the property is TRUE in NI-VISA.
218

    
219
On VXI Instr sessions, if this property is set to FALSE, the END bit terminates read operations."
220
  // STOP ATTRIBUTE
221
  attribute: "File Append En"
222
    "Message Based Settings:File Append Enable"
223
    bool readwrite 80000000 3FFF0192
224
    // const: VI_ATTR_FILE_APPEND_EN
225
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
226
  // STOP ATTRIBUTE
227
  attribute: "Is 488.2"
228
    "Message Based Settings:Is 488.2 Compliant"
229
    bool readonly 00000000 3FFF019F
230
    // const: VI_ATTR_4882_COMPLIANT
231
    "Returns whether the device is 488.2 compliant."
232
  // STOP ATTRIBUTE
233
  attribute: "IO Prot"
234
    "Message Based Settings:IO Protocol"
235
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
236
    // const: VI_ATTR_IO_PROT
237
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
238
  // STOP ATTRIBUTE
239
  attribute: "Win Base Addr"
240
    "Register Based Settings:Window Base Address"
241
    uL readonly 80000000 3FFF0098
242
    // const: VI_ATTR_WIN_BASE_ADDR
243
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
244
  // STOP ATTRIBUTE
245
  attribute: "Win Size"
246
    "Register Based Settings:Window Size"
247
    uL readonly 80000000 3FFF009A
248
    // const: VI_ATTR_WIN_SIZE
249
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
250
  // STOP ATTRIBUTE
251
  attribute: "Win Access"
252
    "Register Based Settings:Window Access"
253
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
254
    // const: VI_ATTR_WIN_ACCESS
255
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
256
  // STOP ATTRIBUTE
257
  attribute: "Src Increment"
258
    "Register Based Settings:Source Increment Count"
259
    iL readwrite 80000000 3FFF0040
260
    // const: VI_ATTR_SRC_INCREMENT
261
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
262
  // STOP ATTRIBUTE
263
  attribute: "Dest Increment"
264
    "Register Based Settings:Destination Increment Count"
265
    iL readwrite 80000000 3FFF0041
266
    // const: VI_ATTR_DEST_INCREMENT
267
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
268
  // STOP ATTRIBUTE
269
  attribute: "Primary Addr"
270
    "GPIB Settings:Primary Address"
271
    uW readonly 00000000 3FFF0172
272
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
273
    "Returns the primary address of the GPIB device used by the given session."
274
  // STOP ATTRIBUTE
275
  attribute: "Secondary Addr"
276
    "GPIB Settings:Secondary Address"
277
    uW readonly 00000000 3FFF0173
278
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
279
    "Returns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF)."
280
  // STOP ATTRIBUTE
281
  attribute: "Readdress"
282
    "GPIB Settings:Readdressing"
283
    bool readwrite 80000000 3FFF001B
284
    // const: VI_ATTR_GPIB_READDR_EN
285
    "Specifies whether to use repeat addressing before each read or write operation. The default is TRUE."
286
  // STOP ATTRIBUTE
287
  attribute: "Unaddress"
288
    "GPIB Settings:Unaddressing"
289
    bool readwrite 80000000 3FFF0184
290
    // const: VI_ATTR_GPIB_UNADDR_EN
291
    "Specifies whether to unaddress the device (UNT and UNL) after each read or write operation. The default is FALSE."
292
  // STOP ATTRIBUTE
293
  attribute: "REN State"
294
    "GPIB Settings:Line REN State"
295
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
296
    // const: VI_ATTR_GPIB_REN_STATE
297
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
298
  // STOP ATTRIBUTE
299
  attribute: "Bytes at Port"
300
    "Serial Settings:Number of Bytes at Serial Port"
301
    uL readonly 00000000 3FFF00AC
302
    // const: VI_ATTR_ASRL_AVAIL_NUM
303
    "Returns the number of bytes currently available at the serial port used by this session."
304
  // STOP ATTRIBUTE
305
  attribute: "Baud"
306
    "Serial Settings:Baud Rate"
307
    uL readwrite 00000000 3FFF0021
308
    // const: VI_ATTR_ASRL_BAUD
309
    "Specifies the baud rate of the given communications port. The rate is represented as an unsigned 32-bit integer so that any baud rate can be used, but the communications port usually requires a commonly used rate such as 300, 1200, 2400, or 9600 baud."
310
  // STOP ATTRIBUTE
311
  attribute: "Data Bits"
312
    "Serial Settings:Data Bits"
313
    uW readwrite 00000000 3FFF0022
314
    // const: VI_ATTR_ASRL_DATA_BITS
315
    "Specifies the number of data bits contained in each frame. Valid values include 5-8. The data bits for each frame are located in the low-order bits of every byte stored in memory."
316
  // STOP ATTRIBUTE
317
  attribute: "Parity"
318
    "Serial Settings:Parity"
319
    uW enum {None=0, Odd=1, Even=2, Mark=3, Space=4} readwrite 00000000 3FFF0023
320
    // const: VI_ATTR_ASRL_PARITY
321
    "Specifies the parity used with every frame that is transmitted or received. Valid values include: (0) Parity None, (1) Parity Odd, (2) Parity Even, (3) Parity Mark, (4) Parity Space. Mark means that the parity bit exists and is always 1. Space means that the parity bit exists and is always 0."
322
  // STOP ATTRIBUTE
323
  attribute: "Stop Bits"
324
    "Serial Settings:Stop Bits"
325
    uW enum {1.0=10, 1.5=15, 2.0=20} readwrite 00000000 3FFF0024
326
    // const: VI_ATTR_ASRL_STOP_BITS
327
    "Specifies the number of stop bits used to indicate the end of a frame. Valid values include: (10) Stop One, (15) Stop One-and-a-Half, (20) Stop Two."
328
  // STOP ATTRIBUTE
329
  attribute: "Flow Cntrl"
330
    "Serial Settings:Flow Control"
331
    uW enum {None=0, XON/XOFF=1, RTS/CTS=2, "XON/XOFF & RTS/CTS"=3, DTR/DSR=4, "XON/XOFF & DTR/DSR"=5} readwrite 00000004 3FFF0025
332
    // const: VI_ATTR_ASRL_FLOW_CNTRL
333
    "Specifies the flow control method used for both transmitting and receiving data. Valid values include:  (0) Flow None, (1) Flow XON/XOFF, (2) Flow RTS/CTS, (3) Flow XON/XOFF and RTS/CTS, (4) Flow DTR/DSR, (5) Flow XON/XOFF and DTR/DSR. Certain values or combinations of values may not be supported by all serial ports and/or operating systems." "Instr_3FFF0025.html" "..\..\help\lvvisaprop.chm"
334
  // STOP ATTRIBUTE
335
  attribute: "ASRL End In"
336
    "Serial Settings:End Mode for Reads"
337
    uW enum {None=0, "Last Bit"=1, "TermChar"=2} readwrite 80000000 3FFF00B3
338
    // const: VI_ATTR_ASRL_END_IN
339
    "Specifies the method used to terminate read operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar. If the value is (2) TermChar, then the value of the property Termination Character Enable (TermChar En) is ignored. The default is (2) TermChar." "Instr_3FFF00B3.html" "..\..\help\lvvisaprop.chm"
340
  // STOP ATTRIBUTE
341
  attribute: "ASRL End Out"
342
    "Serial Settings:End Mode for Writes"
343
    uW enum {None=0, "Last Bit"=1, "TermChar"=2, Break=3} readwrite 80000000 3FFF00B4
344
    // const: VI_ATTR_ASRL_END_OUT
345
    "Specifies the method used to terminate write operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar, (3) Break. The default is (0) None." "Instr_3FFF00B4.html" "..\..\help\lvvisaprop.chm"
346
  // STOP ATTRIBUTE
347
  attribute: "XON Char"
348
    "Serial Settings:Flow Control XON Character"
349
    uB readwrite 00000000 3FFF00C1
350
    // const: VI_ATTR_ASRL_XON_CHAR
351
    "Specifies the value of the XON character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x11 (Control-Q)."
352
  // STOP ATTRIBUTE
353
  attribute: "XOFF Char"
354
    "Serial Settings:Flow Control XOFF Character"
355
    uB readwrite 00000000 3FFF00C2
356
    // const: VI_ATTR_ASRL_XOFF_CHAR
357
    "Specifies the value of the XOFF character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x13 (Control-S)."
358
  // STOP ATTRIBUTE
359
  attribute: "Replace Char"
360
    "Serial Settings:Error Replacement Character"
361
    uB readwrite 00000000 3FFF00BE
362
    // const: VI_ATTR_ASRL_REPLACE_CHAR
363
    "Specifies the character to use to replace incoming characters that arrive with errors (such as a parity error). The default is 0."
364
  // STOP ATTRIBUTE
365
  attribute: "Discard NUL"
366
    "Serial Settings:Discard NUL Characters"
367
    bool readwrite 00000000 3FFF00B0
368
    // const: VI_ATTR_ASRL_DISCARD_NULL
369
    "Specifies whether to discard each data byte whose value is 0. If this property is TRUE, read operations discard NUL characters. If this property is FALSE, read operations treat NUL characters as normal data characters. For binary transfers, set this property to FALSE. The default is FALSE."
370
  // STOP ATTRIBUTE
371
  attribute: "Break Len"
372
    "Serial Settings:Break Length"
373
    iW readwrite 80000000 3FFF01BD
374
    // const: VI_ATTR_ASRL_BREAK_LEN
375
    "Specifies the duration (in milliseconds) of the break signal asserted when End Mode for Writes (ASRL End Out) is set to Break (3). Valid values include 1-500. The default is 250. If you want to control the assertion state and length of a break signal manually, use the VISA Serial Break VI instead."
376
  // STOP ATTRIBUTE
377
  attribute: "Allow Transmit"
378
    "Serial Settings:Allow Transmit"
379
    bool readwrite 00000000 3FFF01BE
380
    // const: VI_ATTR_ASRL_ALLOW_TRANSMIT
381
    "Specifies whether to allow transmission. If FALSE, the serial port suspends transmission as if an XOFF character has been received. If TRUE, it resumes transmission as if an XON character has been received. If XON/XOFF flow control (software handshaking) is not being used, FALSE is an invalid value. The default is TRUE."
382
  // STOP ATTRIBUTE
383
  attribute: "Wire Mode"
384
    "Serial Settings:Wire Mode"
385
    iW enum {Unknown=-1, RS485/Wire4=0, RS485/Wire2-EchoDTR=1, RS485/Wire2-CtrlDTR=2, RS485/Wire2-Auto=3, RS232/DTE=128, RS232/DCE=129, RS232/AUTO=130} readwrite 00000000 3FFF01BF
386
    // const: VI_ATTR_ASRL_WIRE_MODE
387
    "Specifies the current wire/transceiver mode. For RS485 hardware, this property is valid only with the RS485 serial driver developed by National Instruments. For RS232 hardware, the values RS232/DCE and RS232/AUTO are valid only with RS232 serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware. When this feature is not supported, RS232/DTE is the only valid value."
388
  // STOP ATTRIBUTE
389
  attribute: "Break State"
390
    "Serial Settings:Modem Line Settings:Break State"
391
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF01BC
392
    // const: VI_ATTR_ASRL_BREAK_STATE
393
    "Sets manual control of the serial port's break state. If asserted, this property suspends character transmission and places the transmission line in a break state until this property is unasserted. If you want VISA to send a break signal after each write operation automatically, use the Break Length (Break Len) and End Mode for Writes (ASRL End Out) properties instead. The default is Unasserted."
394
  // STOP ATTRIBUTE
395
  attribute: "CTS State"
396
    "Serial Settings:Modem Line Settings:Line CTS State"
397
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF00AE
398
    // const: VI_ATTR_ASRL_CTS_STATE
399
    "Returns the current state of the Clear To Send (CTS) input signal."
400
  // STOP ATTRIBUTE
401
  attribute: "DCD State"
402
  "Serial Settings:Modem Line Settings:Line DCD State"
403
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00AF
404
    // const: VI_ATTR_ASRL_DCD_STATE
405
    "Specifies the current state of the Data Carrier Detect (DCD) input signal. This is often used by modems to indicate the detection of a carrier (modem) on the phone line. This signal is also known as Receive Line Signal Detect (RLSD). This property is read only except when the Wire Mode property is set to RS232/DCE, or RS232/AUTO with the hardware currently in the DCE state."
406
  // STOP ATTRIBUTE
407
  attribute: "DSR State"
408
    "Serial Settings:Modem Line Settings:Line DSR State"
409
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF00B1
410
    // const: VI_ATTR_ASRL_DSR_STATE
411
    "Returns the current state of the Data Set Ready (DSR) input signal."
412
  // STOP ATTRIBUTE
413
  attribute: "DTR State"
414
    "Serial Settings:Modem Line Settings:Line DTR State"
415
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00B2
416
    // const: VI_ATTR_ASRL_DTR_STATE
417
    "Asserts or unasserts the Data Terminal Ready (DTR) output signal manually."
418
  // STOP ATTRIBUTE
419
  attribute: "RI State"
420
    "Serial Settings:Modem Line Settings:Line RI State"
421
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00BF
422
    // const: VI_ATTR_ASRL_RI_STATE
423
    "Specifies the current state of the Ring Indicator (RI) input signal. The RI signal is often used by modems to indicate that the telephone line is ringing. This property is read only except when the Wire Mode property is set to RS232/DCE or to RS232/AUTO with the hardware currently in the DCE state."
424
  // STOP ATTRIBUTE
425
  attribute: "RTS State"
426
    "Serial Settings:Modem Line Settings:Line RTS State"
427
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00C0
428
    // const: VI_ATTR_ASRL_RTS_STATE
429
    "Asserts or unasserts the Request To Send (RTS) output signal manually. When the flow control is set to hardware handshaking, it is invalid to change this property."
430
  // STOP ATTRIBUTE
431
  attribute: "Is Connected"
432
    "Serial Settings:Is Port Connected"
433
    bool readonly 00000000 3FFF01BB
434
    // const: VI_ATTR_ASRL_CONNECTED
435
    "Returns whether the port is properly connected to another port or device. This property is valid only with serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware."
436
  // STOP ATTRIBUTE
437
  attribute: "Device Num"
438
    "PXI/PCI Settings:PCI Device Number"
439
    uW readonly 00000000 3FFF0201
440
    // const: VI_ATTR_PXI_DEV_NUM
441
    "Returns the PCI device number of the PXI/PCI resource."
442
  // STOP ATTRIBUTE
443
  attribute: "Function Num"
444
    "PXI/PCI Settings:PCI Function Number"
445
    uW readonly 00000000 3FFF0202
446
    // const: VI_ATTR_PXI_FUNC_NUM
447
    "Returns the PCI function number of the PXI/PCI resource. For most devices, the PCI function number is 0, but a multifunction device may have a function number up to 7. The meaning of a function number other than 0 is device-specific."
448
  // STOP ATTRIBUTE
449
  attribute: "Bus Num"
450
    "PXI/PCI Settings:PCI Bus Number"
451
    uW readonly 00000000 3FFF0205
452
    // const: VI_ATTR_PXI_BUS_NUM
453
    "Returns the PCI bus number of the PXI/PCI resource."
454
  // STOP ATTRIBUTE
455
  attribute: "Chassis Num"
456
    "PXI/PCI Settings:PXI Chassis Number"
457
    iW readonly 00000000 3FFF0206
458
    // const: VI_ATTR_PXI_CHASSIS
459
    "Returns the PXI chassis number of this device. A value of -1 means the chassis number is unknown. Other valid values are 0 to 255."
460
  // STOP ATTRIBUTE
461
  attribute: "Slot Path"
462
    "PXI/PCI Settings:Slot Path"
463
    string readonly 00000000 BFFF0207
464
    // const: VI_ATTR_PXI_SLOTPATH
465
    "Returns the slot path of this device."
466
  // STOP ATTRIBUTE
467
  attribute: "Loc Bus Left"
468
    "PXI/PCI Settings:Slot Local Bus Left"
469
    iW readonly 00000000 3FFF0208
470
    // const: VI_ATTR_PXI_SLOT_LBUS_LEFT
471
    "Returns the slot number or special feature connected to the local bus left lines of this device."
472
  // STOP ATTRIBUTE
473
  attribute: "Loc Bus Right"
474
    "PXI/PCI Settings:Slot Local Bus Right"
475
    iW readonly 00000000 3FFF0209
476
    // const: VI_ATTR_PXI_SLOT_LBUS_RIGHT
477
    "Returns the slot number or special feature connected to the local bus right lines of this device."
478
  // STOP ATTRIBUTE
479
  attribute: "Trig Bus"
480
    "PXI/PCI Settings:Trigger Bus Number"
481
    iW readonly 00000000 3FFF020A
482
    // const: VI_ATTR_PXI_TRIG_BUS
483
    "Returns the trigger bus number of this device."
484
  // STOP ATTRIBUTE
485
  attribute: "Star Trig Bus"
486
    "PXI/PCI Settings:Star Trigger Bus Number"
487
    iW readonly 00000000 3FFF020B
488
    // const: VI_ATTR_PXI_STAR_TRIG_BUS
489
    "Returns the star trigger bus number of this device."
490
  // STOP ATTRIBUTE
491
  attribute: "Star Trig Line"
492
    "PXI/PCI Settings:Star Trigger Line"
493
    iW readonly 00000000 3FFF020C
494
    // const: VI_ATTR_PXI_STAR_TRIG_LINE
495
    "Returns the PXI_STAR line connected to this device."
496
  // STOP ATTRIBUTE
497
  attribute: "Is PCI Express"
498
    "PXI/PCI Settings:Express Settings:Is PCI Express"
499
    bool readonly 00000000 3FFF0240
500
    // const: VI_ATTR_PXI_IS_EXPRESS
501
    "Returns whether the device is PXI/PCI or PXI/PCI Express."
502
  // STOP ATTRIBUTE
503
  attribute: "Max Link Width"
504
    "PXI/PCI Settings:Express Settings:Maximum Link Width"
505
    iW readonly 00000000 3FFF0242
506
    // const: VI_ATTR_PXI_MAX_LWIDTH
507
    "Returns the maximum PCI Express link width of the device. A value of -1 indicates that the device is not a PXI/PCI Express device. Common values include 1, 2, 4, 8, and 16."
508
  // STOP ATTRIBUTE
509
  attribute: "Link Width"
510
    "PXI/PCI Settings:Express Settings:Actual Link Width"
511
    iW readonly 00000000 3FFF0243
512
    // const: VI_ATTR_PXI_ACTUAL_LWIDTH
513
    "Returns the PCI Express link width negotiated between the PCI Express host controller and the device. A value of -1 indicates that the device is not a PXI/PCI Express device. Common values include 1, 2, 4, 8, and 16."
514
  // STOP ATTRIBUTE
515
  attribute: "Slot Link Width"
516
    "PXI/PCI Settings:Express Settings:Slot Link Width"
517
    iW readonly 00000000 3FFF0241
518
    // const: VI_ATTR_PXI_SLOT_LWIDTH
519
    "Returns the PCI Express link width of the PXI Express peripheral slot in which the device resides. A value of -1 indicates that the device is not a PXI Express device. Common values include 1, 4, and 8."
520
  // STOP ATTRIBUTE
521
  attribute: "D-Star Bus"
522
    "PXI/PCI Settings:Express Settings:D-Star Bus Number"
523
    iW readonly 00000000 3FFF0244
524
    // const: VI_ATTR_PXI_DSTAR_BUS
525
    "Returns the differential star bus number of this device. A value of -1 means that the chassis is unidentified or does not have a timing slot."
526
  // STOP ATTRIBUTE
527
  attribute: "D-Star Set"
528
    "PXI/PCI Settings:Express Settings:D-Star Set"
529
    iW readonly 00000000 3FFF0245
530
    // const: VI_ATTR_PXI_DSTAR_SET
531
    "Returns the set of differential star lines connected to this device. A value of -1 means that the chassis is unidentified or does not have a timing slot."
532
  // STOP ATTRIBUTE
533
  attribute: "BAR0 Type"
534
    "PXI/PCI Settings:PCI Resources:BAR0 Address Type"
535
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0211
536
    // const: VI_ATTR_PXI_MEM_TYPE_BAR0
537
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0)."
538
  // STOP ATTRIBUTE
539
  attribute: "BAR1 Type"
540
    "PXI/PCI Settings:PCI Resources:BAR1 Address Type"
541
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0212
542
    // const: VI_ATTR_PXI_MEM_TYPE_BAR1
543
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0)."
544
  // STOP ATTRIBUTE
545
  attribute: "BAR2 Type"
546
    "PXI/PCI Settings:PCI Resources:BAR2 Address Type"
547
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0213
548
    // const: VI_ATTR_PXI_MEM_TYPE_BAR2
549
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0)."
550
  // STOP ATTRIBUTE
551
  attribute: "BAR3 Type"
552
    "PXI/PCI Settings:PCI Resources:BAR3 Address Type"
553
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0214
554
    // const: VI_ATTR_PXI_MEM_TYPE_BAR3
555
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0)."
556
  // STOP ATTRIBUTE
557
  attribute: "BAR4 Type"
558
    "PXI/PCI Settings:PCI Resources:BAR4 Address Type"
559
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0215
560
    // const: VI_ATTR_PXI_MEM_TYPE_BAR4
561
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0)."
562
  // STOP ATTRIBUTE
563
  attribute: "BAR5 Type"
564
    "PXI/PCI Settings:PCI Resources:BAR5 Address Type"
565
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0216
566
    // const: VI_ATTR_PXI_MEM_BASE_BAR5
567
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, the value is None (0)."
568
  // STOP ATTRIBUTE
569
  attribute: "BAR0 Base"
570
    "PXI/PCI Settings:PCI Resources:BAR0 Address Base"
571
    uL readonly 00000000 3FFF0221
572
    // const: VI_ATTR_PXI_MEM_BASE_BAR0
573
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
574
  // STOP ATTRIBUTE
575
  attribute: "BAR1 Base"
576
    "PXI/PCI Settings:PCI Resources:BAR1 Address Base"
577
    uL readonly 00000000 3FFF0222
578
    // const: VI_ATTR_PXI_MEM_BASE_BAR1
579
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
580
  // STOP ATTRIBUTE
581
  attribute: "BAR2 Base"
582
    "PXI/PCI Settings:PCI Resources:BAR2 Address Base"
583
    uL readonly 00000000 3FFF0223
584
    // const: VI_ATTR_PXI_MEM_BASE_BAR2
585
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
586
  // STOP ATTRIBUTE
587
  attribute: "BAR3 Base"
588
    "PXI/PCI Settings:PCI Resources:BAR3 Address Base"
589
    uL readonly 00000000 3FFF0224
590
    // const: VI_ATTR_PXI_MEM_BASE_BAR3
591
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
592
  // STOP ATTRIBUTE
593
  attribute: "BAR4 Base"
594
    "PXI/PCI Settings:PCI Resources:BAR4 Address Base"
595
    uL readonly 00000000 3FFF0225
596
    // const: VI_ATTR_PXI_MEM_BASE_BAR4
597
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
598
  // STOP ATTRIBUTE
599
  attribute: "BAR5 Base"
600
    "PXI/PCI Settings:PCI Resources:BAR5 Address Base"
601
    uL readonly 00000000 3FFF0226
602
    // const: VI_ATTR_PXI_MEM_BASE_BAR5
603
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
604
  // STOP ATTRIBUTE
605
  attribute: "BAR0 Size"
606
    "PXI/PCI Settings:PCI Resources:BAR0 Address Size"
607
    uL readonly 00000000 3FFF0231
608
    // const: VI_ATTR_PXI_MEM_SIZE_BAR0
609
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
610
  // STOP ATTRIBUTE
611
  attribute: "BAR1 Size"
612
    "PXI/PCI Settings:PCI Resources:BAR1 Address Size"
613
    uL readonly 00000000 3FFF0232
614
    // const: VI_ATTR_PXI_MEM_SIZE_BAR1
615
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
616
  // STOP ATTRIBUTE
617
  attribute: "BAR2 Size"
618
    "PXI/PCI Settings:PCI Resources:BAR2 Address Size"
619
    uL readonly 00000000 3FFF0233
620
    // const: VI_ATTR_PXI_MEM_SIZE_BAR2
621
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
622
  // STOP ATTRIBUTE
623
  attribute: "BAR3 Size"
624
    "PXI/PCI Settings:PCI Resources:BAR3 Address Size"
625
    uL readonly 00000000 3FFF0234
626
    // const: VI_ATTR_PXI_MEM_SIZE_BAR3
627
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
628
  // STOP ATTRIBUTE
629
  attribute: "BAR4 Size"
630
    "PXI/PCI Settings:PCI Resources:BAR4 Address Size"
631
    uL readonly 00000000 3FFF0235
632
    // const: VI_ATTR_PXI_MEM_SIZE_BAR4
633
    "Specifies the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
634
  // STOP ATTRIBUTE
635
  attribute: "BAR5 Size"
636
    "PXI/PCI Settings:PCI Resources:BAR5 Address Size"
637
    uL readonly 00000000 3FFF0236
638
    // const: VI_ATTR_PXI_MEM_SIZE_BAR5
639
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
640
  // STOP ATTRIBUTE
641
  attribute: "TCP Addr"
642
    "TCP/IP Settings:Dot-Notation Address"
643
    string readonly 00000000 BFFF0195
644
    // const: VI_ATTR_TCPIP_ADDR
645
    "Returns the TCPIP address of the device to which the session is connected. This string is formatted in dot notation."
646
  // STOP ATTRIBUTE
647
  attribute: "TCP Hostname"
648
    "TCP/IP Settings:Computer Hostname"
649
    string readonly 00000000 BFFF0196
650
    // const: VI_ATTR_TCPIP_HOSTNAME
651
    "Returns the host name of the device. If no host name is available, this property returns an empty string."
652
  // STOP ATTRIBUTE
653
  attribute: "TCP NoDelay"
654
    "TCP/IP Settings:No Packet Delay"
655
    bool readwrite 80000000 3FFF019A
656
    // const: VI_ATTR_TCPIP_NODELAY
657
    "Specifies whether the Nagle algorithm is enabled. The Nagle algorithm is disabled when this property is TRUE (and vice versa). The Nagle algorithm improves network performance by buffering written data until a full-size packet can be sent. This property is TRUE by default in VISA to verify that writes get flushed immediately."
658
  // STOP ATTRIBUTE
659
  attribute: "TCP KeepAlive"
660
    "TCP/IP Settings:Keep-Alive Packets"
661
    bool readwrite 80000000 3FFF019B
662
    // const: VI_ATTR_TCPIP_KEEPALIVE
663
    "Specifies whether to use keep-alive packets on TCP connections. Setting this property to TRUE requests that a TCP/IP provider enable the use of keep-alive packets on TCP connections. After the system detects a dropped connection, VISA returns a lost connection error code on subsequent I/O calls on the session. The time required for the system to detect the dropped connection depends on the system and is not settable. The default is FALSE."
664
  // STOP ATTRIBUTE
665
  attribute: "TCP DevName"
666
    "TCP/IP Settings:LAN Device Name"
667
    string readonly 00000000 BFFF0199
668
    // const: VI_ATTR_TCPIP_DEVICE_NAME
669
    "Returns the LAN device name used by the VXI-11 protocol (for example, inst0) during connection."
670
  // STOP ATTRIBUTE
671
  attribute: "USB Serial Num"
672
    "USB Settings:Serial Number"
673
    string readonly 00000000 BFFF01A0
674
    // const: VI_ATTR_USB_SERIAL_NUM
675
    "Returns the USB serial number of this device."
676
  // STOP ATTRIBUTE
677
  attribute: "USB Intfc Num"
678
    "USB Settings:USB Interface Number"
679
    iW readonly 00000000 3FFF01A1
680
    // const: VI_ATTR_USB_INTFC_NUM
681
    "Returns the USB interface number used by the given session."
682
  // STOP ATTRIBUTE
683
  attribute: "USB Prot"
684
    "USB Settings:USB Protocol"
685
    iW readonly 00000000 3FFF01A7
686
    // const: VI_ATTR_USB_PROTOCOL
687
    "Returns the USB protocol used by the given session."
688
  // STOP ATTRIBUTE
689
  attribute: "USB Max Intr Size"
690
    "USB Settings:Maximum Interrupt Size"
691
    uW readwrite 80000000 3FFF01AF
692
    // const: VI_ATTR_USB_MAX_INTR_SIZE
693
    "Specifies the maximum size of data stored by any given USB interrupt. If a USB interrupt contains more data than this size, the data in excess of this size is lost. This property is read/write when the corresponding session is not enabled to receive USB interrupt events. When the session is enabled to receive USB interrupt events, this property is read only."
694
  // STOP ATTRIBUTE
695
  attribute: "FDC Channel"
696
    "VXI/VME Settings:Fast Data Channel:Channel Number"
697
    uW readwrite 80000000 3FFF000D
698
    // const: VI_ATTR_FDC_CHNL
699
    "Specifies which FDC channel to use to transfer data buffers. Valid values include 0-7."
700
  // STOP ATTRIBUTE
701
  attribute: "FDC Mode"
702
    "VXI/VME Settings:Fast Data Channel:Channel Mode"
703
    uW enum {Normal=1, Stream=2} readwrite 80000000 3FFF000F
704
    // const: VI_ATTR_FDC_MODE
705
    "Specifies whether FDC transfers use normal or streaming mode. The default is Normal."
706
  // STOP ATTRIBUTE
707
  attribute: "FDC Use Pair"
708
    "VXI/VME Settings:Fast Data Channel:Use Channel Pairs"
709
    bool readwrite 80000000 3FFF0013
710
    // const: VI_ATTR_FDC_USE_PAIR
711
    "Specifies whether transfers use a pair of FDC channels. If you do not set this property, transfers use only one FDC channel. The default is FALSE."
712
  // STOP ATTRIBUTE
713
  attribute: "Mainframe LA"
714
    "VXI/VME Settings:Mainframe Logical Address"
715
    iW readonly 00000000 3FFF0070
716
    // const: VI_ATTR_MAINFRAME_LA
717
    "Returns the lowest logical address in the mainframe in which the device resides."
718
  // STOP ATTRIBUTE
719
  attribute: "Mem Base"
720
    "VXI/VME Settings:VXI Memory Base Address"
721
    uL readonly 00000000 3FFF00AD
722
    // const: VI_ATTR_MEM_BASE
723
    "Returns the base address of the device in VXI memory space."
724
  // STOP ATTRIBUTE
725
  attribute: "Mem Size"
726
    "VXI/VME Settings:VXI Memory Size"
727
    uL readonly 00000000 3FFF00DD
728
    // const: VI_ATTR_MEM_SIZE
729
    "Returns the size of memory requested by the device in VXI memory space."
730
  // STOP ATTRIBUTE
731
  attribute: "Mem Space"
732
    "VXI/VME Settings:VXI Memory Address Space"
733
    uW enum {"VXI/VME A16"=1, "VXI/VME A24"=2, "VXI/VME A32"=3, "VXI/VME A64"=4} readonly 00000000 3FFF00DE
734
    // const: VI_ATTR_MEM_SPACE
735
    "Returns the VXI address space used by the device."
736
  // STOP ATTRIBUTE
737
  attribute: "VXI LA"
738
    "VXI/VME Settings:VXI Logical Address"
739
    iW readonly 00000000 3FFF00D5
740
    // const: VI_ATTR_VXI_LA
741
    "Returns the logical address of the VXI device."
742
  // STOP ATTRIBUTE
743
  attribute: "Immediate Serv"
744
    "VXI/VME Settings:Immediate Servant"
745
    bool readonly 00000000 3FFF0100
746
    // const: VI_ATTR_IMMEDIATE_SERV
747
    "Returns whether the VXI device is an immediate servant of the local controller."
748
  // STOP ATTRIBUTE
749
  attribute: "Cmdr LA"
750
    "VXI/VME Settings:VXI Commander Logical Address"
751
    iW readonly 00000000 3FFF006B
752
    // const: VI_ATTR_CMDR_LA
753
    "Returns the logical address of the commander of the VXI device."
754
  // STOP ATTRIBUTE
755
  attribute: "Src Access Priv"
756
    "VXI/VME Settings:Source Access Privilege"
757
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF003C
758
    // const: VI_ATTR_SRC_ACCESS_PRIV
759
    "Specifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0)."
760
  // STOP ATTRIBUTE
761
  attribute: "Dest Access Priv"
762
    "VXI/VME Settings:Destination Access Privilege"
763
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0039
764
    // const: VI_ATTR_DEST_ACCESS_PRIV
765
    "Specifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0)."
766
  // STOP ATTRIBUTE
767
  attribute: "Win Access Priv"
768
    "VXI/VME Settings:Window Access Privilege"
769
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0045
770
    // const: VI_ATTR_WIN_ACCESS_PRIV
771
    "Specifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0)."
772
  // STOP ATTRIBUTE
773
  attribute: "Src Byte Order"
774
    "VXI/VME Settings:Source Byte Order"
775
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003D
776
    // const: VI_ATTR_SRC_BYTE_ORDER
777
    "Specifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0)."
778
  // STOP ATTRIBUTE
779
  attribute: "Dest Byte Order"
780
    "VXI/VME Settings:Destination Byte Order"
781
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003A
782
    // const: VI_ATTR_DEST_BYTE_ORDER
783
    "Specifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0)."
784
  // STOP ATTRIBUTE
785
  attribute: "Win Byte Order"
786
    "VXI/VME Settings:Window Byte Order"
787
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF0047
788
    // const: VI_ATTR_WIN_BYTE_ORDER
789
    "Specifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0)."
790
  // STOP ATTRIBUTE
791
  attribute: "VXI Trig Supp"
792
    "VXI/VME Settings:Supported VXI Trigger Lines"
793
    uL readonly 00000000 3FFF0194
794
    // const: VI_ATTR_VXI_TRIG_SUPPORT
795
    "Returns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1."
796
  // STOP ATTRIBUTE
797
  attribute: "VXI Dev Class"
798
    "VXI/VME Settings:VXI Device Class"
799
    uW enum {Memory=0, Extended=1, Message=2, Register=3, Other=4} readonly 00000000 3FFF006C
800
    // const: VI_ATTR_VXI_DEV_CLASS
801
    "Returns the class to which the VXI or VME device belongs."
802
  // STOP ATTRIBUTE
803
  attribute: "1394 Dest Upper"
804
    "FireWire Settings:Destination Upper Offset"
805
     uW readwrite 80000000 3FFF01F0
806
    // const: VI_ATTR_FIREWIRE_DEST_UPPER_OFFSET
807
    "Specifies the upper 16 bits of the 48-bit destination address for a FireWire device. The default is 0xFFFF."
808
  // STOP ATTRIBUTE
809
  attribute: "1394 Src Upper"
810
    "FireWire Settings:Source Upper Offset"
811
     uW readwrite 80000000 3FFF01F1
812
    // const: VI_ATTR_FIREWIRE_SRC_UPPER_OFFSET
813
    "Specifies the upper 16 bits of the 48-bit source address for a FireWire device. The default is 0xFFFF."
814
  // STOP ATTRIBUTE
815
  attribute: "1394 Win Upper"
816
    "FireWire Settings:Window Upper Offset"
817
     uW readwrite 80000000 3FFF01F2
818
    // const: VI_ATTR_FIREWIRE_WIN_UPPER_OFFSET
819
    "Specifies the upper 16 bits of the 48-bit address for a FireWire device when a window is mapped. The default is 0xFFFF."
820
  // STOP ATTRIBUTE
821
  attribute: "1394 Vendor"
822
    "FireWire Settings:Vendor ID"
823
     uL readonly 00000000 3FFF01F3
824
    // const: VI_ATTR_FIREWIRE_VENDOR_ID
825
    "Returns the vendor ID for a FireWire device."
826
  // STOP ATTRIBUTE
827
  attribute: "1394 Lower Chip"
828
    "FireWire Settings:Lower Chip ID"
829
     uL readonly 00000000 3FFF01F4
830
    // const: VI_ATTR_FIREWIRE_LOWER_CHIP_ID
831
    "Returns the lower chip ID for a FireWire device."
832
  // STOP ATTRIBUTE
833
  attribute: "1394 Upper Chip"
834
    "FireWire Settings:Upper Chip ID"
835
     uB readonly 00000000 3FFF01F5
836
    // const: VI_ATTR_FIREWIRE_UPPER_CHIP_ID
837
    "Returns the upper chip ID for a FireWire device."
838
  // STOP ATTRIBUTE
839
  attribute: "Intf Parent Num"
840
    "Interface Information:Interface Number of Parent"
841
    uW readonly 00000000 3FFF0101
842
    // const: VI_ATTR_INTF_PARENT_NUM
843
    "Returns the board number of the parent device.
844

    
845
<B>Note:</B> In the Instr class, this property is valid only for GPIB-VXI resources."
846
  // STOP ATTRIBUTE
847
  // STOP ATTRIBUTE LIST
848

    
849
  method: "VISA Read" noInvoke
850
  method: "VISA Write" noInvoke
851
  method: "VISA Read To File" noInvoke
852
  method: "VISA Write From File" noInvoke
853
  method: "VISA Clear" noInvoke
854
  method: "VISA Read STB" noInvoke
855
  method: "VISA Assert Trigger" noInvoke
856
  method: "VISA In 64" noInvoke
857
  method: "VISA In 32" noInvoke
858
  method: "VISA In 16" noInvoke
859
  method: "VISA In 8" noInvoke
860
  method: "VISA Out 64" noInvoke
861
  method: "VISA Out 32" noInvoke
862
  method: "VISA Out 16" noInvoke
863
  method: "VISA Out 8" noInvoke
864
  method: "VISA Map Address" noInvoke
865
  method: "VISA Unmap Address" noInvoke
866
  method: "VISA Peek 64" noInvoke
867
  method: "VISA Peek 32" noInvoke
868
  method: "VISA Peek 16" noInvoke
869
  method: "VISA Peek 8" noInvoke
870
  method: "VISA Poke 64" noInvoke
871
  method: "VISA Poke 32" noInvoke
872
  method: "VISA Poke 16" noInvoke
873
  method: "VISA Poke 8" noInvoke
874
  method: "VISA Move In 8" noInvoke
875
  method: "VISA Move In 16" noInvoke
876
  method: "VISA Move In 32" noInvoke
877
  method: "VISA Move In 64" noInvoke
878
  method: "VISA Move Out 8" noInvoke
879
  method: "VISA Move Out 16" noInvoke
880
  method: "VISA Move Out 32" noInvoke
881
  method: "VISA Move Out 64" noInvoke
882
  method: "VISA Mem Alloc" noInvoke
883
  method: "VISA Memory Allocation Ex" noInvoke
884
  method: "VISA Mem Free" noInvoke
885
  method: "VISA Set I/O Buffer Size" noInvoke
886
  method: "VISA Flush I/O Buffer" noInvoke
887
  method: "VISA GPIB Control REN" noInvoke
888
  method: "VISA VXI Cmd or Query" noInvoke
889
  method: "VISA USB Control Out" noInvoke
890
  method: "VISA USB Control In" noInvoke
891

    
892
// STOP CLASS
893

    
894
class: "GPIB Instr"
895
super: "I/O Session"
896
sorted: no
897
classString: "GPIB?*::INSTR"
898
  attribute: "Allow DMA"
899
    "General Settings:Allow DMA Transfers"
900
    bool readwrite 80000000 3FFF001E
901
    // const: VI_ATTR_DMA_ALLOW_EN
902
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
903
  // STOP ATTRIBUTE
904
  attribute: "TermChar"
905
    "Message Based Settings:Termination Character"
906
    uB readwrite 80000000 3FFF0018
907
    // const: VI_ATTR_TERMCHAR
908
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
909
  // STOP ATTRIBUTE
910
  attribute: "TermChar En"
911
    "Message Based Settings:Termination Character Enable"
912
    bool readwrite 80000000 3FFF0038
913
    // const: VI_ATTR_TERMCHAR_EN
914
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
915
  // STOP ATTRIBUTE
916
  attribute: "Send End En"
917
    "Message Based Settings:Send End Enable"
918
    bool readwrite 80000000 3FFF0016
919
    // const: VI_ATTR_SEND_END_EN
920
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
921

    
922
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the property End Mode for Writes (ASRL End Out).
923

    
924
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
925
  // STOP ATTRIBUTE
926
  attribute: "File Append En"
927
    "Message Based Settings:File Append Enable"
928
    bool readwrite 80000000 3FFF0192
929
    // const: VI_ATTR_FILE_APPEND_EN
930
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
931
  // STOP ATTRIBUTE
932
  attribute: "IO Prot"
933
    "Message Based Settings:IO Protocol"
934
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
935
    // const: VI_ATTR_IO_PROT
936
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
937
  // STOP ATTRIBUTE
938
  attribute: "Primary Addr"
939
    "GPIB Settings:Primary Address"
940
    uW readonly 00000000 3FFF0172
941
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
942
    "Returns the primary address of the GPIB device used by the given session."
943
  // STOP ATTRIBUTE
944
  attribute: "Secondary Addr"
945
    "GPIB Settings:Secondary Address"
946
    uW readonly 00000000 3FFF0173
947
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
948
    "Returns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF)."
949
  // STOP ATTRIBUTE
950
  attribute: "Readdress"
951
    "GPIB Settings:Readdressing"
952
    bool readwrite 80000000 3FFF001B
953
    // const: VI_ATTR_GPIB_READDR_EN
954
    "Specifies whether to use repeat addressing before each read or write operation. The default is TRUE."
955
  // STOP ATTRIBUTE
956
  attribute: "Unaddress"
957
    "GPIB Settings:Unaddressing"
958
    bool readwrite 80000000 3FFF0184
959
    // const: VI_ATTR_GPIB_UNADDR_EN
960
    "Specifies whether to unaddress the device (UNT and UNL) after each read or write operation. The default is FALSE."
961
  // STOP ATTRIBUTE
962
  attribute: "REN State"
963
    "GPIB Settings:Line REN State"
964
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
965
    // const: VI_ATTR_GPIB_REN_STATE
966
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
967
  // STOP ATTRIBUTE
968
  // STOP ATTRIBUTE LIST
969

    
970
  method: "VISA Read" noInvoke
971
  method: "VISA Write" noInvoke
972
  method: "VISA Read To File" noInvoke
973
  method: "VISA Write From File" noInvoke
974
  method: "VISA Clear" noInvoke
975
  method: "VISA Read STB" noInvoke
976
  method: "VISA Assert Trigger" noInvoke
977
  method: "VISA GPIB Control REN" noInvoke
978

    
979
// STOP CLASS
980

    
981
class: "VXI/GPIB-VXI MBD Instr"
982
super: "I/O Session"
983
sorted: no
984
classString: "?*VXI?*::INSTR"
985
  attribute: "Intf Parent Num"
986
    "Interface Information:Interface Number of Parent"
987
    uW readonly 00000000 3FFF0101
988
    // const: VI_ATTR_INTF_PARENT_NUM
989
    "Returns the board number of the parent device."
990
  // STOP ATTRIBUTE
991
  attribute: "Allow DMA"
992
    "General Settings:Allow DMA Transfers"
993
    bool readwrite 80000000 3FFF001E
994
    // const: VI_ATTR_DMA_ALLOW_EN
995
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
996
  // STOP ATTRIBUTE
997
  attribute: "Trigger Id"
998
    "General Settings:Trigger Identifier"
999
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readwrite 80000000 3FFF0177
1000
    // const: VI_ATTR_TRIG_ID
1001
    "Specifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software."
1002
  // STOP ATTRIBUTE
1003
  attribute: "Manf Name"
1004
    "General Settings:Manufacturer Name"
1005
    string readonly 00000000 BFFF0072
1006
    // const: VI_ATTR_MANF_NAME
1007
    "Returns the name of the manufacturer that created the device.
1008

    
1009
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
1010
  // STOP ATTRIBUTE
1011
  attribute: "Model Name"
1012
    "General Settings:Model Name"
1013
    string readonly 00000000 BFFF0077
1014
    // const: VI_ATTR_MODEL_NAME
1015
    "Returns the model name of the device. 
1016

    
1017
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
1018
  // STOP ATTRIBUTE
1019
  attribute: "Manf Id"
1020
    "General Settings:Manufacturer Identification"
1021
    uW readonly 00000000 3FFF00D9
1022
    // const: VI_ATTR_MANF_ID
1023
    "Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID)."
1024
  // STOP ATTRIBUTE
1025
  attribute: "Model Code"
1026
    "General Settings:Model Code"
1027
    uW readonly 00000000 3FFF00DF
1028
    // const: VI_ATTR_MODEL_CODE
1029
    "Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID)."
1030
  // STOP ATTRIBUTE
1031
  attribute: "Slot"
1032
    "General Settings:Slot"
1033
    iW readonly 00000000 3FFF00E8
1034
    // const: VI_ATTR_SLOT
1035
    "Returns the physical slot location of the device. If the slot is unknown, the value returned is -1."
1036
  // STOP ATTRIBUTE
1037
  attribute: "TermChar"
1038
    "Message Based Settings:Termination Character"
1039
    uB readwrite 80000000 3FFF0018
1040
    // const: VI_ATTR_TERMCHAR
1041
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
1042
  // STOP ATTRIBUTE
1043
  attribute: "TermChar En"
1044
    "Message Based Settings:Termination Character Enable"
1045
    bool readwrite 80000000 3FFF0038
1046
    // const: VI_ATTR_TERMCHAR_EN
1047
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
1048
  // STOP ATTRIBUTE
1049
  attribute: "Send End En"
1050
    "Message Based Settings:Send End Enable"
1051
    bool readwrite 80000000 3FFF0016
1052
    // const: VI_ATTR_SEND_END_EN
1053
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
1054

    
1055
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the property End Mode for Writes (ASRL End Out).
1056

    
1057
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
1058
  // STOP ATTRIBUTE
1059
  attribute: "Suppress End En"
1060
    "Message Based Settings:Suppress End Enable"
1061
    bool readwrite 80000000 3FFF0036
1062
    // const: VI_ATTR_SUPPRESS_END_EN
1063
    "Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations.
1064

    
1065
For all session types that support this property, if this property is set to TRUE, read does not terminate due to an END condition. However, a read may still terminate successfully if the Message Based Settings:Termination Character Enable (TermChar En) property is set to TRUE. Otherwise, read does not terminate until it receives all of the requested data (or an error occurs). The default is FALSE (except for TCP/IP Socket sessions).
1066

    
1067
On Serial Instr sessions, if this property is set to FALSE, VISA performs the behavior described in the Serial Settings:End Mode for Reads (ASRL End In) property.
1068

    
1069
On USB Raw sessions, if this property is set to FALSE, VISA performs the behavior described in the USB Settings:End Mode for Reads (USB End In) property.
1070

    
1071
On TCP/IP Socket sessions, if this property is set to FALSE, if NI-VISA reads some data and then detects a pause in the arrival of data packets, it terminates the read operation. On TCP/IP Socket sessions, the default value for the property is TRUE in NI-VISA.
1072

    
1073
On VXI Instr sessions, if this property is set to FALSE, the END bit terminates read operations."
1074
  // STOP ATTRIBUTE
1075
  attribute: "File Append En"
1076
    "Message Based Settings:File Append Enable"
1077
    bool readwrite 80000000 3FFF0192
1078
    // const: VI_ATTR_FILE_APPEND_EN
1079
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
1080
  // STOP ATTRIBUTE
1081
  attribute: "Is 488.2"
1082
    "Message Based Settings:Is 488.2 Compliant"
1083
    bool readonly 00000000 3FFF019F
1084
    // const: VI_ATTR_4882_COMPLIANT
1085
    "Returns whether the device is 488.2 compliant."
1086
  // STOP ATTRIBUTE
1087
  attribute: "IO Prot"
1088
    "Message Based Settings:IO Protocol"
1089
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
1090
    // const: VI_ATTR_IO_PROT
1091
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
1092
  // STOP ATTRIBUTE
1093
  attribute: "Win Base Addr"
1094
    "Register Based Settings:Window Base Address"
1095
    uL readonly 80000000 3FFF0098
1096
    // const: VI_ATTR_WIN_BASE_ADDR
1097
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
1098
  // STOP ATTRIBUTE
1099
  attribute: "Win Size"
1100
    "Register Based Settings:Window Size"
1101
    uL readonly 80000000 3FFF009A
1102
    // const: VI_ATTR_WIN_SIZE
1103
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
1104
  // STOP ATTRIBUTE
1105
  attribute: "Win Access"
1106
    "Register Based Settings:Window Access"
1107
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
1108
    // const: VI_ATTR_WIN_ACCESS
1109
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
1110
  // STOP ATTRIBUTE
1111
  attribute: "Src Increment"
1112
    "Register Based Settings:Source Increment Count"
1113
    iL readwrite 80000000 3FFF0040
1114
    // const: VI_ATTR_SRC_INCREMENT
1115
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
1116
  // STOP ATTRIBUTE
1117
  attribute: "Dest Increment"
1118
    "Register Based Settings:Destination Increment Count"
1119
    iL readwrite 80000000 3FFF0041
1120
    // const: VI_ATTR_DEST_INCREMENT
1121
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
1122
  // STOP ATTRIBUTE
1123
  attribute: "FDC Channel"
1124
    "VXI/VME Settings:Fast Data Channel:Channel Number"
1125
    uW readwrite 80000000 3FFF000D
1126
    // const: VI_ATTR_FDC_CHNL
1127
    "Specifies which FDC channel to use to transfer data buffers. Valid values include 0-7."
1128
  // STOP ATTRIBUTE
1129
  attribute: "FDC Mode"
1130
    "VXI/VME Settings:Fast Data Channel:Channel Mode"
1131
    uW enum {Normal=1, Stream=2} readwrite 80000000 3FFF000F
1132
    // const: VI_ATTR_FDC_MODE
1133
    "Specifies whether FDC transfers use normal or streaming mode. The default is Normal."
1134
  // STOP ATTRIBUTE
1135
  attribute: "FDC Use Pair"
1136
    "VXI/VME Settings:Fast Data Channel:Use Channel Pairs"
1137
    bool readwrite 80000000 3FFF0013
1138
    // const: VI_ATTR_FDC_USE_PAIR
1139
    "Specifies whether transfers use a pair of FDC channels. If you do not set this property, transfers use only one FDC channel. The default is FALSE."
1140
  // STOP ATTRIBUTE
1141
  attribute: "Primary Addr"
1142
    "GPIB Settings:Primary Address"
1143
    uW readonly 00000000 3FFF0172
1144
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
1145
    "Returns the primary address of the GPIB device used by the given session."
1146
  // STOP ATTRIBUTE
1147
  attribute: "Secondary Addr"
1148
    "GPIB Settings:Secondary Address"
1149
    uW readonly 00000000 3FFF0173
1150
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
1151
    "Returns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF)."
1152
  // STOP ATTRIBUTE
1153
  attribute: "Readdress"
1154
    "GPIB Settings:Readdressing"
1155
    bool readwrite 80000000 3FFF001B
1156
    // const: VI_ATTR_GPIB_READDR_EN
1157
    "Specifies whether to use repeat addressing before each read or write operation. The default is TRUE."
1158
  // STOP ATTRIBUTE
1159
  attribute: "Unaddress"
1160
    "GPIB Settings:Unaddressing"
1161
    bool readwrite 80000000 3FFF0184
1162
    // const: VI_ATTR_GPIB_UNADDR_EN
1163
    "Specifies whether to unaddress the device (UNT and UNL) after each read or write operation. The default is FALSE."
1164
  // STOP ATTRIBUTE
1165
  attribute: "REN State"
1166
    "GPIB Settings:Line REN State"
1167
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
1168
    // const: VI_ATTR_GPIB_REN_STATE
1169
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
1170
  // STOP ATTRIBUTE
1171
  attribute: "Mainframe LA"
1172
    "VXI/VME Settings:Mainframe Logical Address"
1173
    iW readonly 00000000 3FFF0070
1174
    // const: VI_ATTR_MAINFRAME_LA
1175
    "Returns the lowest logical address in the mainframe in which the device resides."
1176
  // STOP ATTRIBUTE
1177
  attribute: "Mem Base"
1178
    "VXI/VME Settings:VXI Memory Base Address"
1179
    uL readonly 00000000 3FFF00AD
1180
    // const: VI_ATTR_MEM_BASE
1181
    "Returns the base address of the device in VXI memory space."
1182
  // STOP ATTRIBUTE
1183
  attribute: "Mem Size"
1184
    "VXI/VME Settings:VXI Memory Size"
1185
    uL readonly 00000000 3FFF00DD
1186
    // const: VI_ATTR_MEM_SIZE
1187
    "Returns the size of memory requested by the device in VXI memory space."
1188
  // STOP ATTRIBUTE
1189
  attribute: "Mem Space"
1190
    "VXI/VME Settings:VXI Memory Address Space"
1191
    uW enum {"VXI/VME A16"=1, "VXI/VME A24"=2, "VXI/VME A32"=3, "VXI/VME A64"=4} readonly 00000000 3FFF00DE
1192
    // const: VI_ATTR_MEM_SPACE
1193
    "Returns the VXI address space used by the device."
1194
  // STOP ATTRIBUTE
1195
  attribute: "VXI LA"
1196
    "VXI/VME Settings:VXI Logical Address"
1197
    iW readonly 00000000 3FFF00D5
1198
    // const: VI_ATTR_VXI_LA
1199
    "Returns the logical address of the VXI device."
1200
  // STOP ATTRIBUTE
1201
  attribute: "Immediate Serv"
1202
    "VXI/VME Settings:Immediate Servant"
1203
    bool readonly 00000000 3FFF0100
1204
    // const: VI_ATTR_IMMEDIATE_SERV
1205
    "Returns whether the VXI device is an immediate servant of the local controller."
1206
  // STOP ATTRIBUTE
1207
  attribute: "Cmdr LA"
1208
    "VXI/VME Settings:VXI Commander Logical Address"
1209
    iW readonly 00000000 3FFF006B
1210
    // const: VI_ATTR_CMDR_LA
1211
    "Returns the logical address of the commander of the VXI device."
1212
  // STOP ATTRIBUTE
1213
  attribute: "Src Access Priv"
1214
    "VXI/VME Settings:Source Access Privilege"
1215
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF003C
1216
    // const: VI_ATTR_SRC_ACCESS_PRIV
1217
    "Specifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0)."
1218
  // STOP ATTRIBUTE
1219
  attribute: "Dest Access Priv"
1220
    "VXI/VME Settings:Destination Access Privilege"
1221
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0039
1222
    // const: VI_ATTR_DEST_ACCESS_PRIV
1223
    "Specifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0)."
1224
  // STOP ATTRIBUTE
1225
  attribute: "Win Access Priv"
1226
    "VXI/VME Settings:Window Access Privilege"
1227
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0045
1228
    // const: VI_ATTR_WIN_ACCESS_PRIV
1229
    "Specifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0)."
1230
  // STOP ATTRIBUTE
1231
  attribute: "Src Byte Order"
1232
    "VXI/VME Settings:Source Byte Order"
1233
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003D
1234
    // const: VI_ATTR_SRC_BYTE_ORDER
1235
    "Specifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0)."
1236
  // STOP ATTRIBUTE
1237
  attribute: "Dest Byte Order"
1238
    "VXI/VME Settings:Destination Byte Order"
1239
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003A
1240
    // const: VI_ATTR_DEST_BYTE_ORDER
1241
    "Specifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0)."
1242
  // STOP ATTRIBUTE
1243
  attribute: "Win Byte Order"
1244
    "VXI/VME Settings:Window Byte Order"
1245
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF0047
1246
    // const: VI_ATTR_WIN_BYTE_ORDER
1247
    "Specifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0)."
1248
  // STOP ATTRIBUTE
1249
  attribute: "VXI Trig Supp"
1250
    "VXI/VME Settings:Supported VXI Trigger Lines"
1251
    uL readonly 00000000 3FFF0194
1252
    // const: VI_ATTR_VXI_TRIG_SUPPORT
1253
    "Returns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1."
1254
  // STOP ATTRIBUTE
1255
  attribute: "VXI Dev Class"
1256
    "VXI/VME Settings:VXI Device Class"
1257
    uW enum {Memory=0, Extended=1, Message=2, Register=3, Other=4} readonly 00000000 3FFF006C
1258
    // const: VI_ATTR_VXI_DEV_CLASS
1259
    "Returns the class to which the VXI or VME device belongs."
1260
  // STOP ATTRIBUTE
1261
  // STOP ATTRIBUTE LIST
1262

    
1263
  method: "VISA Read" noInvoke
1264
  method: "VISA Write" noInvoke
1265
  method: "VISA Read To File" noInvoke
1266
  method: "VISA Write From File" noInvoke
1267
  method: "VISA Clear" noInvoke
1268
  method: "VISA Read STB" noInvoke
1269
  method: "VISA Assert Trigger" noInvoke
1270
  method: "VISA In 64" noInvoke
1271
  method: "VISA In 32" noInvoke
1272
  method: "VISA In 16" noInvoke
1273
  method: "VISA In 8" noInvoke
1274
  method: "VISA Out 64" noInvoke
1275
  method: "VISA Out 32" noInvoke
1276
  method: "VISA Out 16" noInvoke
1277
  method: "VISA Out 8" noInvoke
1278
  method: "VISA Map Address" noInvoke
1279
  method: "VISA Unmap Address" noInvoke
1280
  method: "VISA Peek 64" noInvoke
1281
  method: "VISA Peek 32" noInvoke
1282
  method: "VISA Peek 16" noInvoke
1283
  method: "VISA Peek 8" noInvoke
1284
  method: "VISA Poke 64" noInvoke
1285
  method: "VISA Poke 32" noInvoke
1286
  method: "VISA Poke 16" noInvoke
1287
  method: "VISA Poke 8" noInvoke
1288
  method: "VISA Move In 8" noInvoke
1289
  method: "VISA Move In 16" noInvoke
1290
  method: "VISA Move In 32" noInvoke
1291
  method: "VISA Move In 64" noInvoke
1292
  method: "VISA Move Out 8" noInvoke
1293
  method: "VISA Move Out 16" noInvoke
1294
  method: "VISA Move Out 32" noInvoke
1295
  method: "VISA Move Out 64" noInvoke
1296
  method: "VISA Mem Alloc" noInvoke
1297
  method: "VISA Memory Allocation Ex" noInvoke
1298
  method: "VISA Mem Free" noInvoke
1299
  method: "VISA VXI Cmd or Query" noInvoke
1300

    
1301
// STOP CLASS
1302

    
1303
class: "VXI/GPIB-VXI/VME RBD Instr"
1304
super: "I/O Session"
1305
sorted: no
1306
classString: "?*VXI?*::INSTR"
1307
  attribute: "Intf Parent Num"
1308
    "Interface Information:Interface Number of Parent"
1309
    uW readonly 00000000 3FFF0101
1310
    // const: VI_ATTR_INTF_PARENT_NUM
1311
    "Returns the board number of the parent device."
1312
  // STOP ATTRIBUTE
1313
  attribute: "Allow DMA"
1314
    "General Settings:Allow DMA Transfers"
1315
    bool readwrite 80000000 3FFF001E
1316
    // const: VI_ATTR_DMA_ALLOW_EN
1317
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
1318
  // STOP ATTRIBUTE
1319
  attribute: "Trigger Id"
1320
    "General Settings:Trigger Identifier"
1321
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readwrite 80000000 3FFF0177
1322
    // const: VI_ATTR_TRIG_ID
1323
    "Specifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software."
1324
  // STOP ATTRIBUTE
1325
  attribute: "Manf Name"
1326
    "General Settings:Manufacturer Name"
1327
    string readonly 00000000 BFFF0072
1328
    // const: VI_ATTR_MANF_NAME
1329
    "Returns the name of the manufacturer that created the device.
1330

    
1331
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
1332
  // STOP ATTRIBUTE
1333
  attribute: "Model Name"
1334
    "General Settings:Model Name"
1335
    string readonly 00000000 BFFF0077
1336
    // const: VI_ATTR_MODEL_NAME
1337
    "Returns the model name of the device. 
1338

    
1339
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
1340
  // STOP ATTRIBUTE
1341
  attribute: "Manf Id"
1342
    "General Settings:Manufacturer Identification"
1343
    uW readonly 00000000 3FFF00D9
1344
    // const: VI_ATTR_MANF_ID
1345
    "Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID)."
1346
  // STOP ATTRIBUTE
1347
  attribute: "Model Code"
1348
    "General Settings:Model Code"
1349
    uW readonly 00000000 3FFF00DF
1350
    // const: VI_ATTR_MODEL_CODE
1351
    "Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID)."
1352
  // STOP ATTRIBUTE
1353
  attribute: "Slot"
1354
    "General Settings:Slot"
1355
    iW readonly 00000000 3FFF00E8
1356
    // const: VI_ATTR_SLOT
1357
    "Returns the physical slot location of the device. If the slot is unknown, the value returned is -1."
1358
  // STOP ATTRIBUTE
1359
  attribute: "Primary Addr"
1360
    "GPIB Settings:Primary Address"
1361
    uW readonly 00000000 3FFF0172
1362
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
1363
    "Returns the primary address of the GPIB device used by the given session."
1364
  // STOP ATTRIBUTE
1365
  attribute: "Secondary Addr"
1366
    "GPIB Settings:Secondary Address"
1367
    uW readonly 00000000 3FFF0173
1368
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
1369
    "Returns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF)."
1370
  // STOP ATTRIBUTE
1371
  attribute: "REN State"
1372
    "GPIB Settings:Line REN State"
1373
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
1374
    // const: VI_ATTR_GPIB_REN_STATE
1375
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
1376
  // STOP ATTRIBUTE
1377
  attribute: "Win Base Addr"
1378
    "Register Based Settings:Window Base Address"
1379
    uL readonly 80000000 3FFF0098
1380
    // const: VI_ATTR_WIN_BASE_ADDR
1381
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
1382
  // STOP ATTRIBUTE
1383
  attribute: "Win Size"
1384
    "Register Based Settings:Window Size"
1385
    uL readonly 80000000 3FFF009A
1386
    // const: VI_ATTR_WIN_SIZE
1387
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
1388
  // STOP ATTRIBUTE
1389
  attribute: "Win Access"
1390
    "Register Based Settings:Window Access"
1391
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
1392
    // const: VI_ATTR_WIN_ACCESS
1393
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
1394
  // STOP ATTRIBUTE
1395
  attribute: "Src Increment"
1396
    "Register Based Settings:Source Increment Count"
1397
    iL readwrite 80000000 3FFF0040
1398
    // const: VI_ATTR_SRC_INCREMENT
1399
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
1400
  // STOP ATTRIBUTE
1401
  attribute: "Dest Increment"
1402
    "Register Based Settings:Destination Increment Count"
1403
    iL readwrite 80000000 3FFF0041
1404
    // const: VI_ATTR_DEST_INCREMENT
1405
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
1406
  // STOP ATTRIBUTE
1407
  attribute: "Mainframe LA"
1408
    "VXI/VME Settings:Mainframe Logical Address"
1409
    iW readonly 00000000 3FFF0070
1410
    // const: VI_ATTR_MAINFRAME_LA
1411
    "Returns the lowest logical address in the mainframe in which the device resides."
1412
  // STOP ATTRIBUTE
1413
  attribute: "Mem Base"
1414
    "VXI/VME Settings:VXI Memory Base Address"
1415
    uL readonly 00000000 3FFF00AD
1416
    // const: VI_ATTR_MEM_BASE
1417
    "Returns the base address of the device in VXI memory space."
1418
  // STOP ATTRIBUTE
1419
  attribute: "Mem Size"
1420
    "VXI/VME Settings:VXI Memory Size"
1421
    uL readonly 00000000 3FFF00DD
1422
    // const: VI_ATTR_MEM_SIZE
1423
    "Returns the size of memory requested by the device in VXI memory space."
1424
  // STOP ATTRIBUTE
1425
  attribute: "Mem Space"
1426
    "VXI/VME Settings:VXI Memory Address Space"
1427
    uW enum {"VXI/VME A16"=1, "VXI/VME A24"=2, "VXI/VME A32"=3, "VXI/VME A64"=4} readonly 00000000 3FFF00DE
1428
    // const: VI_ATTR_MEM_SPACE
1429
    "Returns the VXI address space used by the device."
1430
  // STOP ATTRIBUTE
1431
  attribute: "VXI LA"
1432
    "VXI/VME Settings:VXI Logical Address"
1433
    iW readonly 00000000 3FFF00D5
1434
    // const: VI_ATTR_VXI_LA
1435
    "Returns the logical address of the VXI device."
1436
  // STOP ATTRIBUTE
1437
  attribute: "Immediate Serv"
1438
    "VXI/VME Settings:Immediate Servant"
1439
    bool readonly 00000000 3FFF0100
1440
    // const: VI_ATTR_IMMEDIATE_SERV
1441
    "Returns whether the VXI device is an immediate servant of the local controller."
1442
  // STOP ATTRIBUTE
1443
  attribute: "Cmdr LA"
1444
    "VXI/VME Settings:VXI Commander Logical Address"
1445
    iW readonly 00000000 3FFF006B
1446
    // const: VI_ATTR_CMDR_LA
1447
    "Returns the logical address of the commander of the VXI device."
1448
  // STOP ATTRIBUTE
1449
  attribute: "Src Access Priv"
1450
    "VXI/VME Settings:Source Access Privilege"
1451
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF003C
1452
    // const: VI_ATTR_SRC_ACCESS_PRIV
1453
    "Specifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0)."
1454
  // STOP ATTRIBUTE
1455
  attribute: "Dest Access Priv"
1456
    "VXI/VME Settings:Destination Access Privilege"
1457
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0039
1458
    // const: VI_ATTR_DEST_ACCESS_PRIV
1459
    "Specifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0)."
1460
  // STOP ATTRIBUTE
1461
  attribute: "Win Access Priv"
1462
    "VXI/VME Settings:Window Access Privilege"
1463
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0045
1464
    // const: VI_ATTR_WIN_ACCESS_PRIV
1465
    "Specifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0)."
1466
  // STOP ATTRIBUTE
1467
  attribute: "Src Byte Order"
1468
    "VXI/VME Settings:Source Byte Order"
1469
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003D
1470
    // const: VI_ATTR_SRC_BYTE_ORDER
1471
    "Specifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0)."
1472
  // STOP ATTRIBUTE
1473
  attribute: "Dest Byte Order"
1474
    "VXI/VME Settings:Destination Byte Order"
1475
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003A
1476
    // const: VI_ATTR_DEST_BYTE_ORDER
1477
    "Specifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0)."
1478
  // STOP ATTRIBUTE
1479
  attribute: "Win Byte Order"
1480
    "VXI/VME Settings:Window Byte Order"
1481
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF0047
1482
    // const: VI_ATTR_WIN_BYTE_ORDER
1483
    "Specifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0)."
1484
  // STOP ATTRIBUTE
1485
  attribute: "VXI Trig Supp"
1486
    "VXI/VME Settings:Supported VXI Trigger Lines"
1487
    uL readonly 00000000 3FFF0194
1488
    // const: VI_ATTR_VXI_TRIG_SUPPORT
1489
    "Returns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1."
1490
  // STOP ATTRIBUTE
1491
  attribute: "VXI Dev Class"
1492
    "VXI/VME Settings:VXI Device Class"
1493
    uW enum {Memory=0, Extended=1, Message=2, Register=3, Other=4} readonly 00000000 3FFF006C
1494
    // const: VI_ATTR_VXI_DEV_CLASS
1495
    "Returns the class to which the VXI or VME device belongs."
1496
  // STOP ATTRIBUTE
1497
  // STOP ATTRIBUTE LIST
1498

    
1499
  method: "VISA Assert Trigger" noInvoke
1500
  method: "VISA In 64" noInvoke
1501
  method: "VISA In 32" noInvoke
1502
  method: "VISA In 16" noInvoke
1503
  method: "VISA In 8" noInvoke
1504
  method: "VISA Out 64" noInvoke
1505
  method: "VISA Out 32" noInvoke
1506
  method: "VISA Out 16" noInvoke
1507
  method: "VISA Out 8" noInvoke
1508
  method: "VISA Map Address" noInvoke
1509
  method: "VISA Unmap Address" noInvoke
1510
  method: "VISA Peek 64" noInvoke
1511
  method: "VISA Peek 32" noInvoke
1512
  method: "VISA Peek 16" noInvoke
1513
  method: "VISA Peek 8" noInvoke
1514
  method: "VISA Poke 64" noInvoke
1515
  method: "VISA Poke 32" noInvoke
1516
  method: "VISA Poke 16" noInvoke
1517
  method: "VISA Poke 8" noInvoke
1518
  method: "VISA Move In 8" noInvoke
1519
  method: "VISA Move In 16" noInvoke
1520
  method: "VISA Move In 32" noInvoke
1521
  method: "VISA Move In 64" noInvoke
1522
  method: "VISA Move Out 8" noInvoke
1523
  method: "VISA Move Out 16" noInvoke
1524
  method: "VISA Move Out 32" noInvoke
1525
  method: "VISA Move Out 64" noInvoke
1526
  method: "VISA Mem Alloc" noInvoke
1527
  method: "VISA Memory Allocation Ex" noInvoke
1528
  method: "VISA Mem Free" noInvoke
1529

    
1530
// STOP CLASS
1531

    
1532
class: "PXI Instr"
1533
super: "I/O Session"
1534
sorted: no
1535
classString: "PXI?*::INSTR"
1536
  attribute: "Trigger Id"
1537
    "General Settings:Trigger Identifier"
1538
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readwrite 80000000 3FFF0177
1539
    // const: VI_ATTR_TRIG_ID
1540
    "Specifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software."
1541
  // STOP ATTRIBUTE
1542
  attribute: "Allow DMA"
1543
    "General Settings:Allow DMA Transfers"
1544
    bool readwrite 80000000 3FFF001E
1545
    // const: VI_ATTR_DMA_ALLOW_EN
1546
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
1547
  // STOP ATTRIBUTE
1548
  attribute: "Manf Name"
1549
    "General Settings:Manufacturer Name"
1550
    string readonly 00000000 BFFF0072
1551
    // const: VI_ATTR_MANF_NAME
1552
    "Returns the name of the manufacturer that created the device.
1553

    
1554
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
1555
  // STOP ATTRIBUTE
1556
  attribute: "Model Name"
1557
    "General Settings:Model Name"
1558
    string readonly 00000000 BFFF0077
1559
    // const: VI_ATTR_MODEL_NAME
1560
    "Returns the model name of the device. 
1561

    
1562
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
1563
  // STOP ATTRIBUTE
1564
  attribute: "Manf Id"
1565
    "General Settings:Manufacturer Identification"
1566
    uW readonly 00000000 3FFF00D9
1567
    // const: VI_ATTR_MANF_ID
1568
    "Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID)."
1569
  // STOP ATTRIBUTE
1570
  attribute: "Model Code"
1571
    "General Settings:Model Code"
1572
    uW readonly 00000000 3FFF00DF
1573
    // const: VI_ATTR_MODEL_CODE
1574
    "Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID)."
1575
  // STOP ATTRIBUTE
1576
  attribute: "Slot"
1577
    "General Settings:Slot"
1578
    iW readonly 00000000 3FFF00E8
1579
    // const: VI_ATTR_SLOT
1580
    "Returns the physical slot location of the device. If the slot is unknown, the value returned is -1."
1581
  // STOP ATTRIBUTE
1582
  attribute: "Win Base Addr"
1583
    "Register Based Settings:Window Base Address"
1584
    uL readonly 80000000 3FFF0098
1585
    // const: VI_ATTR_WIN_BASE_ADDR
1586
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
1587
  // STOP ATTRIBUTE
1588
  attribute: "Win Size"
1589
    "Register Based Settings:Window Size"
1590
    uL readonly 80000000 3FFF009A
1591
    // const: VI_ATTR_WIN_SIZE
1592
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
1593
  // STOP ATTRIBUTE
1594
  attribute: "Win Access"
1595
    "Register Based Settings:Window Access"
1596
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
1597
    // const: VI_ATTR_WIN_ACCESS
1598
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
1599
  // STOP ATTRIBUTE
1600
  attribute: "Src Increment"
1601
    "Register Based Settings:Source Increment Count"
1602
    iL readwrite 80000000 3FFF0040
1603
    // const: VI_ATTR_SRC_INCREMENT
1604
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
1605
  // STOP ATTRIBUTE
1606
  attribute: "Dest Increment"
1607
    "Register Based Settings:Destination Increment Count"
1608
    iL readwrite 80000000 3FFF0041
1609
    // const: VI_ATTR_DEST_INCREMENT
1610
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
1611
  // STOP ATTRIBUTE
1612
  attribute: "Device Num"
1613
    "PXI/PCI Settings:PCI Device Number"
1614
    uW readonly 00000000 3FFF0201
1615
    // const: VI_ATTR_PXI_DEV_NUM
1616
    "Returns the PCI device number of the PXI/PCI resource."
1617
  // STOP ATTRIBUTE
1618
  attribute: "Function Num"
1619
    "PXI/PCI Settings:PCI Function Number"
1620
    uW readonly 00000000 3FFF0202
1621
    // const: VI_ATTR_PXI_FUNC_NUM
1622
    "Returns the PCI function number of the PXI/PCI resource. For most devices the function number is 0, but a multifunction device may have a function number up to 7. The meaning of a function number other than 0 is device-specific."
1623
  // STOP ATTRIBUTE
1624
  attribute: "Bus Num"
1625
    "PXI/PCI Settings:PCI Bus Number"
1626
    uW readonly 00000000 3FFF0205
1627
    // const: VI_ATTR_PXI_BUS_NUM
1628
    "Returns the PCI bus number of the PXI/PCI resource."
1629
  // STOP ATTRIBUTE
1630
  attribute: "Chassis Num"
1631
    "PXI/PCI Settings:PXI Chassis Number"
1632
    iW readonly 00000000 3FFF0206
1633
    // const: VI_ATTR_PXI_CHASSIS
1634
    "Returns the PXI chassis number of this device. A value of -1 means the chassis number is unknown. Other valid values are 0 to 255."
1635
  // STOP ATTRIBUTE
1636
  attribute: "Slot Path"
1637
    "PXI/PCI Settings:Slot Path"
1638
    string readonly 00000000 BFFF0207
1639
    // const: VI_ATTR_PXI_SLOTPATH
1640
    "Returns the slot path of this device."
1641
  // STOP ATTRIBUTE
1642
  attribute: "Loc Bus Left"
1643
    "PXI/PCI Settings:Slot Local Bus Left"
1644
    iW readonly 00000000 3FFF0208
1645
    // const: VI_ATTR_PXI_SLOT_LBUS_LEFT
1646
    "Returns the slot number or special feature connected to the local bus left lines of this device."
1647
  // STOP ATTRIBUTE
1648
  attribute: "Loc Bus Right"
1649
    "PXI/PCI Settings:Slot Local Bus Right"
1650
    iW readonly 00000000 3FFF0209
1651
    // const: VI_ATTR_PXI_SLOT_LBUS_RIGHT
1652
    "Returns the slot number or special feature connected to the local bus right lines of this device."
1653
  // STOP ATTRIBUTE
1654
  attribute: "Trig Bus"
1655
    "PXI/PCI Settings:Trigger Bus Number"
1656
    iW readonly 00000000 3FFF020A
1657
    // const: VI_ATTR_PXI_TRIG_BUS
1658
    "Returns the trigger bus number of this device."
1659
  // STOP ATTRIBUTE
1660
  attribute: "Star Trig Bus"
1661
    "PXI/PCI Settings:Star Trigger Bus Number"
1662
    iW readonly 00000000 3FFF020B
1663
    // const: VI_ATTR_PXI_STAR_TRIG_BUS
1664
    "Returns the star trigger bus number of this device."
1665
  // STOP ATTRIBUTE
1666
  attribute: "Star Trig Line"
1667
    "PXI/PCI Settings:Star Trigger Line"
1668
    iW readonly 00000000 3FFF020C
1669
    // const: VI_ATTR_PXI_STAR_TRIG_LINE
1670
    "Returns the PXI_STAR line connected to this device."
1671
  // STOP ATTRIBUTE
1672
  attribute: "Is PCI Express"
1673
    "PXI/PCI Settings:Express Settings:Is PCI Express"
1674
    bool readonly 00000000 3FFF0240
1675
    // const: VI_ATTR_PXI_IS_EXPRESS
1676
    "Returns whether the device is PXI/PCI or PXI/PCI Express."
1677
  // STOP ATTRIBUTE
1678
  attribute: "Max Link Width"
1679
    "PXI/PCI Settings:Express Settings:Maximum Link Width"
1680
    iW readonly 00000000 3FFF0242
1681
    // const: VI_ATTR_PXI_MAX_LWIDTH
1682
    "Returns the maximum PCI Express link width of the device. A value of -1 indicates that the device is not a PXI/PCI Express device. Common values include 1, 2, 4, 8, and 16."
1683
  // STOP ATTRIBUTE
1684
  attribute: "Link Width"
1685
    "PXI/PCI Settings:Express Settings:Actual Link Width"
1686
    iW readonly 00000000 3FFF0243
1687
    // const: VI_ATTR_PXI_ACTUAL_LWIDTH
1688
    "Returns the PCI Express link width negotiated between the PCI Express host controller and the device. A value of -1 indicates that the device is not a PXI/PCI Express device. Common values include 1, 2, 4, 8, and 16."
1689
  // STOP ATTRIBUTE
1690
  attribute: "Slot Link Width"
1691
    "PXI/PCI Settings:Express Settings:Slot Link Width"
1692
    iW readonly 00000000 3FFF0241
1693
    // const: VI_ATTR_PXI_SLOT_LWIDTH
1694
    "Returns the PCI Express link width of the PXI Express peripheral slot in which the device resides. A value of -1 indicates that the device is not a PXI Express device. Common values include 1, 4, and 8."
1695
  // STOP ATTRIBUTE
1696
  attribute: "D-Star Bus"
1697
    "PXI/PCI Settings:Express Settings:D-Star Bus Number"
1698
    iW readonly 00000000 3FFF0244
1699
    // const: VI_ATTR_PXI_DSTAR_BUS
1700
    "Returns the differential star bus number of this device. A value of -1 means that the chassis is unidentified or does not have a timing slot."
1701
  // STOP ATTRIBUTE
1702
  attribute: "D-Star Set"
1703
    "PXI/PCI Settings:Express Settings:D-Star Set"
1704
    iW readonly 00000000 3FFF0245
1705
    // const: VI_ATTR_PXI_DSTAR_SET
1706
    "Returns the set of differential star lines connected to this device. A value of -1 means that the chassis is unidentified or does not have a timing slot."
1707
  // STOP ATTRIBUTE
1708
  attribute: "BAR0 Type"
1709
    "PXI/PCI Settings:PCI Resources:BAR0 Address Type"
1710
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0211
1711
    // const: VI_ATTR_PXI_MEM_TYPE_BAR0
1712
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, this property returns None (0)."
1713
  // STOP ATTRIBUTE
1714
  attribute: "BAR1 Type"
1715
    "PXI/PCI Settings:PCI Resources:BAR1 Address Type"
1716
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0212
1717
    // const: VI_ATTR_PXI_MEM_TYPE_BAR1
1718
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, this property returns None (0)."
1719
  // STOP ATTRIBUTE
1720
  attribute: "BAR2 Type"
1721
    "PXI/PCI Settings:PCI Resources:BAR2 Address Type"
1722
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0213
1723
    // const: VI_ATTR_PXI_MEM_TYPE_BAR2
1724
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, this property returns None (0)."
1725
  // STOP ATTRIBUTE
1726
  attribute: "BAR3 Type"
1727
    "PXI/PCI Settings:PCI Resources:BAR3 Address Type"
1728
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0214
1729
    // const: VI_ATTR_PXI_MEM_TYPE_BAR3
1730
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, this property returns None (0)."
1731
  // STOP ATTRIBUTE
1732
  attribute: "BAR4 Type"
1733
    "PXI/PCI Settings:PCI Resources:BAR4 Address Type"
1734
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0215
1735
    // const: VI_ATTR_PXI_MEM_TYPE_BAR4
1736
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, this property returns None (0)."
1737
  // STOP ATTRIBUTE
1738
  attribute: "BAR5 Type"
1739
    "PXI/PCI Settings:PCI Resources:BAR5 Address Type"
1740
    uW enum {None=0, Memory=1, I/O=2} readonly 00000000 3FFF0216
1741
    // const: VI_ATTR_PXI_MEM_TYPE_BAR5
1742
    "Returns what type of address requirements (memory or I/O) the device has for this Base Address Register. If the device does not request addresses in this space, this property returns None (0)."
1743
  // STOP ATTRIBUTE
1744
  attribute: "BAR0 Base"
1745
    "PXI/PCI Settings:PCI Resources:BAR0 Address Base"
1746
    uL readonly 00000000 3FFF0221
1747
    // const: VI_ATTR_PXI_MEM_BASE_BAR0
1748
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
1749
  // STOP ATTRIBUTE
1750
  attribute: "BAR1 Base"
1751
    "PXI/PCI Settings:PCI Resources:BAR1 Address Base"
1752
    uL readonly 00000000 3FFF0222
1753
    // const: VI_ATTR_PXI_MEM_BASE_BAR1
1754
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
1755
  // STOP ATTRIBUTE
1756
  attribute: "BAR2 Base"
1757
    "PXI/PCI Settings:PCI Resources:BAR2 Address Base"
1758
    uL readonly 00000000 3FFF0223
1759
    // const: VI_ATTR_PXI_MEM_BASE_BAR2
1760
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
1761
  // STOP ATTRIBUTE
1762
  attribute: "BAR3 Base"
1763
    "PXI/PCI Settings:PCI Resources:BAR3 Address Base"
1764
    uL readonly 00000000 3FFF0224
1765
    // const: VI_ATTR_PXI_MEM_BASE_BAR3
1766
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
1767
  // STOP ATTRIBUTE
1768
  attribute: "BAR4 Base"
1769
    "PXI/PCI Settings:PCI Resources:BAR4 Address Base"
1770
    uL readonly 00000000 3FFF0225
1771
    // const: VI_ATTR_PXI_MEM_BASE_BAR4
1772
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
1773
  // STOP ATTRIBUTE
1774
  attribute: "BAR5 Base"
1775
    "PXI/PCI Settings:PCI Resources:BAR5 Address Base"
1776
    uL readonly 00000000 3FFF0226
1777
    // const: VI_ATTR_PXI_MEM_BASE_BAR5
1778
    "Returns the system-assigned base this device uses in the given space. If the device does not request addresses in this space, the value of this property is meaningless."
1779
  // STOP ATTRIBUTE
1780
  attribute: "BAR0 Size"
1781
    "PXI/PCI Settings:PCI Resources:BAR0 Address Size"
1782
    uL readonly 00000000 3FFF0231
1783
    // const: VI_ATTR_PXI_MEM_SIZE_BAR0
1784
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
1785
  // STOP ATTRIBUTE
1786
  attribute: "BAR1 Size"
1787
    "PXI/PCI Settings:PCI Resources:BAR1 Address Size"
1788
    uL readonly 00000000 3FFF0232
1789
    // const: VI_ATTR_PXI_MEM_SIZE_BAR1
1790
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
1791
  // STOP ATTRIBUTE
1792
  attribute: "BAR2 Size"
1793
    "PXI/PCI Settings:PCI Resources:BAR2 Address Size"
1794
    uL readonly 00000000 3FFF0233
1795
    // const: VI_ATTR_PXI_MEM_SIZE_BAR2
1796
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
1797
  // STOP ATTRIBUTE
1798
  attribute: "BAR3 Size"
1799
    "PXI/PCI Settings:PCI Resources:BAR3 Address Size"
1800
    uL readonly 00000000 3FFF0234
1801
    // const: VI_ATTR_PXI_MEM_SIZE_BAR3
1802
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
1803
  // STOP ATTRIBUTE
1804
  attribute: "BAR4 Size"
1805
    "PXI/PCI Settings:PCI Resources:BAR4 Address Size"
1806
    uL readonly 00000000 3FFF0235
1807
    // const: VI_ATTR_PXI_MEM_SIZE_BAR4
1808
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
1809
  // STOP ATTRIBUTE
1810
  attribute: "BAR5 Size"
1811
    "PXI/PCI Settings:PCI Resources:BAR5 Address Size"
1812
    uL readonly 00000000 3FFF0236
1813
    // const: VI_ATTR_PXI_MEM_SIZE_BAR5
1814
    "Returns the requested address size of this device in the given space. If the device does not request addresses in this space, the value is meaningless. If this value cannot be determined safely, this property returns the value 0xFFFFFFFF."
1815
  // STOP ATTRIBUTE
1816
  // STOP ATTRIBUTE LIST
1817

    
1818
  method: "VISA Assert Trigger" noInvoke
1819
  method: "VISA In 64" noInvoke
1820
  method: "VISA In 32" noInvoke
1821
  method: "VISA In 16" noInvoke
1822
  method: "VISA In 8" noInvoke
1823
  method: "VISA Out 64" noInvoke
1824
  method: "VISA Out 32" noInvoke
1825
  method: "VISA Out 16" noInvoke
1826
  method: "VISA Out 8" noInvoke
1827
  method: "VISA Map Address" noInvoke
1828
  method: "VISA Unmap Address" noInvoke
1829
  method: "VISA Peek 64" noInvoke
1830
  method: "VISA Peek 32" noInvoke
1831
  method: "VISA Peek 16" noInvoke
1832
  method: "VISA Peek 8" noInvoke
1833
  method: "VISA Poke 64" noInvoke
1834
  method: "VISA Poke 32" noInvoke
1835
  method: "VISA Poke 16" noInvoke
1836
  method: "VISA Poke 8" noInvoke
1837
  method: "VISA Move In 8" noInvoke
1838
  method: "VISA Move In 16" noInvoke
1839
  method: "VISA Move In 32" noInvoke
1840
  method: "VISA Move In 64" noInvoke
1841
  method: "VISA Move Out 8" noInvoke
1842
  method: "VISA Move Out 16" noInvoke
1843
  method: "VISA Move Out 32" noInvoke
1844
  method: "VISA Move Out 64" noInvoke
1845

    
1846
// STOP CLASS
1847

    
1848
class: "Serial Instr"
1849
super: "I/O Session"
1850
sorted: no
1851
classString: "ASRL?*::INSTR"
1852
  attribute: "Allow DMA"
1853
    "General Settings:Allow DMA Transfers"
1854
    bool readwrite 80000000 3FFF001E
1855
    // const: VI_ATTR_DMA_ALLOW_EN
1856
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
1857
  // STOP ATTRIBUTE
1858
  attribute: "TermChar"
1859
    "Message Based Settings:Termination Character"
1860
    uB readwrite 80000000 3FFF0018
1861
    // const: VI_ATTR_TERMCHAR
1862
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
1863
  // STOP ATTRIBUTE
1864
  attribute: "TermChar En"
1865
    "Message Based Settings:Termination Character Enable"
1866
    bool readwrite 80000000 3FFF0038
1867
    // const: VI_ATTR_TERMCHAR_EN
1868
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
1869
  // STOP ATTRIBUTE
1870
  attribute: "Send End En"
1871
    "Message Based Settings:Send End Enable"
1872
    bool readwrite 80000000 3FFF0016
1873
    // const: VI_ATTR_SEND_END_EN
1874
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
1875

    
1876
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
1877

    
1878
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
1879
  // STOP ATTRIBUTE
1880
  attribute: "Suppress End En"
1881
    "Message Based Settings:Suppress End Enable"
1882
    bool readwrite 80000000 3FFF0036
1883
    // const: VI_ATTR_SUPPRESS_END_EN
1884
    "Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations.
1885

    
1886
For all session types that support this property, if this property is set to TRUE, read does not terminate due to an END condition. However, a read may still terminate successfully if the Message Based Settings:Termination Character Enable (TermChar En) property is set to TRUE. Otherwise, read does not terminate until it receives all of the requested data (or an error occurs). The default is FALSE (except for TCP/IP Socket sessions).
1887

    
1888
On Serial Instr sessions, if this property is set to FALSE, VISA performs the behavior described in the Serial Settings:End Mode for Reads (ASRL End In) property.
1889

    
1890
On USB Raw sessions, if this property is set to FALSE, VISA performs the behavior described in the USB Settings:End Mode for Reads (USB End In) property.
1891

    
1892
On TCP/IP Socket sessions, if this property is set to FALSE, if NI-VISA reads some data and then detects a pause in the arrival of data packets, it terminates the read operation. On TCP/IP Socket sessions, the default value for the property is TRUE in NI-VISA.
1893

    
1894
On VXI Instr sessions, if this property is set to FALSE, the END bit terminates read operations."
1895
  // STOP ATTRIBUTE
1896
  attribute: "File Append En"
1897
    "Message Based Settings:File Append Enable"
1898
    bool readwrite 80000000 3FFF0192
1899
    // const: VI_ATTR_FILE_APPEND_EN
1900
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
1901
  // STOP ATTRIBUTE
1902
  attribute: "IO Prot"
1903
    "Message Based Settings:IO Protocol"
1904
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
1905
    // const: VI_ATTR_IO_PROT
1906
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
1907
  // STOP ATTRIBUTE
1908
  attribute: "Bytes at Port"
1909
    "Serial Settings:Number of Bytes at Serial Port"
1910
    uL readonly 00000000 3FFF00AC
1911
    // const: VI_ATTR_ASRL_AVAIL_NUM
1912
    "Returns the number of bytes currently available at the serial port used by this session."
1913
  // STOP ATTRIBUTE
1914
  attribute: "Baud"
1915
    "Serial Settings:Baud Rate"
1916
    uL readwrite 00000000 3FFF0021
1917
    // const: VI_ATTR_ASRL_BAUD
1918
    "Specifies the baud rate of the given communications port."
1919
  // STOP ATTRIBUTE
1920
  attribute: "Data Bits"
1921
    "Serial Settings:Data Bits"
1922
    uW readwrite 00000000 3FFF0022
1923
    // const: VI_ATTR_ASRL_DATA_BITS
1924
    "Specifies the number of data bits contained in each frame. Valid values include 5-8."
1925
  // STOP ATTRIBUTE
1926
  attribute: "Parity"
1927
    "Serial Settings:Parity"
1928
    uW enum {None=0, Odd=1, Even=2, Mark=3, Space=4} readwrite 00000000 3FFF0023
1929
    // const: VI_ATTR_ASRL_PARITY
1930
    "Specifies the parity used with every frame that is transmitted or received. Valid values include: (0) Parity None, (1) Parity Odd, (2) Parity Even, (3) Parity Mark, (4) Parity Space. Mark means that the parity bit exists and is always 1. Space means that the parity bit exists and is always 0."
1931
  // STOP ATTRIBUTE
1932
  attribute: "Stop Bits"
1933
    "Serial Settings:Stop Bits"
1934
    uW enum {1.0=10, 1.5=15, 2.0=20} readwrite 00000000 3FFF0024
1935
    // const: VI_ATTR_ASRL_STOP_BITS
1936
    "Specifies the number of stop bits used to indicate the end of a frame. Valid values include: (10) Stop One, (15) Stop One-and-a-Half, (20) Stop Two."
1937
  // STOP ATTRIBUTE
1938
  attribute: "Flow Cntrl"
1939
    "Serial Settings:Flow Control"
1940
    uW enum {None=0, XON/XOFF=1, RTS/CTS=2, "XON/XOFF & RTS/CTS"=3, DTR/DSR=4, "XON/XOFF & DTR/DSR"=5} readwrite 00000004 3FFF0025
1941
    // const: VI_ATTR_ASRL_FLOW_CNTRL
1942
    "Specifies the flow control method used for both transmitting and receiving data. Valid values include: (0) Flow None, (1) Flow XON/XOFF, (2) Flow RTS/CTS, (3) Flow XON/XOFF and RTS/CTS, (4) Flow DTR/DSR, (5) Flow XON/XOFF and DTR/DSR. Certain values or combinations of values may not be supported by all serial ports and/or operating systems." "Instr_3FFF0025.html" "..\..\help\lvvisaprop.chm"
1943
  // STOP ATTRIBUTE
1944
  attribute: "ASRL End In"
1945
    "Serial Settings:End Mode for Reads"
1946
    uW enum {None=0, "Last Bit"=1, "TermChar"=2} readwrite 80000000 3FFF00B3
1947
    // const: VI_ATTR_ASRL_END_IN
1948
    "Specifies the method used to terminate read operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar. If the value is (2) TermChar, then the value of the property Termination Character Enable (TermChar En) is ignored. The default is (2) TermChar." "Instr_3FFF00B3.html" "..\..\help\lvvisaprop.chm"
1949
  // STOP ATTRIBUTE
1950
  attribute: "ASRL End Out"
1951
    "Serial Settings:End Mode for Writes"
1952
    uW enum {None=0, "Last Bit"=1, "TermChar"=2, Break=3} readwrite 80000000 3FFF00B4
1953
    // const: VI_ATTR_ASRL_END_OUT
1954
    "Specifies the method used to terminate write operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar, (3) Break. The default is (0) None." "Instr_3FFF00B4.html" "..\..\help\lvvisaprop.chm"
1955
  // STOP ATTRIBUTE
1956
  attribute: "XON Char"
1957
    "Serial Settings:Flow Control XON Character"
1958
    uB readwrite 00000000 3FFF00C1
1959
    // const: VI_ATTR_ASRL_XON_CHAR
1960
    "Specifies the value of the XON character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x11 (Control-Q)."
1961
  // STOP ATTRIBUTE
1962
  attribute: "XOFF Char"
1963
    "Serial Settings:Flow Control XOFF Character"
1964
    uB readwrite 00000000 3FFF00C2
1965
    // const: VI_ATTR_ASRL_XOFF_CHAR
1966
    "Specifies the value of the XOFF character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x13 (Control-S)."
1967
  // STOP ATTRIBUTE
1968
  attribute: "Replace Char"
1969
    "Serial Settings:Error Replacement Character"
1970
    uB readwrite 00000000 3FFF00BE
1971
    // const: VI_ATTR_ASRL_REPLACE_CHAR
1972
    "Specifies the character to use to replace incoming characters that arrive with errors (such as a parity error). The default is 0."
1973
  // STOP ATTRIBUTE
1974
  attribute: "Discard NUL"
1975
    "Serial Settings:Discard NUL Characters"
1976
    bool readwrite 00000000 3FFF00B0
1977
    // const: VI_ATTR_ASRL_DISCARD_NULL
1978
    "Specifies whether to discard each data byte whose value is 0. If this property is TRUE, read operations discard NUL characters. If this property is FALSE, read operations treat NUL characters as normal data characters. For binary transfers, set this property to FALSE. The default is FALSE."
1979
  // STOP ATTRIBUTE
1980
  attribute: "Break Len"
1981
    "Serial Settings:Break Length"
1982
    iW readwrite 80000000 3FFF01BD
1983
    // const: VI_ATTR_ASRL_BREAK_LEN
1984
    "Specifies the duration (in milliseconds) of the break signal asserted when End Mode for Writes (ASRL End Out) is set to Break (3). Valid values include 1-500. The default is 250. If you want to control the assertion state and length of a break signal manually, use the VISA Serial Break VI instead."
1985
  // STOP ATTRIBUTE
1986
  attribute: "Allow Transmit"
1987
    "Serial Settings:Allow Transmit"
1988
    bool readwrite 00000000 3FFF01BE
1989
    // const: VI_ATTR_ASRL_ALLOW_TRANSMIT
1990
    "Specifies whether to allow transmission. If FALSE, the serial port suspends transmission as if an XOFF character has been received. If TRUE, it resumes transmission as if an XON character has been received. If XON/XOFF flow control (software handshaking) is not being used, FALSE is an invalid value. The default is TRUE."
1991
  // STOP ATTRIBUTE
1992
  attribute: "Wire Mode"
1993
    "Serial Settings:Wire Mode"
1994
    iW enum {Unknown=-1, RS485/Wire4=0, RS485/Wire2-EchoDTR=1, RS485/Wire2-CtrlDTR=2, RS485/Wire2-Auto=3, RS232/DTE=128, RS232/DCE=129, RS232/AUTO=130} readwrite 00000000 3FFF01BF
1995
    // const: VI_ATTR_ASRL_WIRE_MODE
1996
    "Specifies the current wire/transceiver mode. For RS485 hardware, this property is valid only with the RS485 serial driver developed by National Instruments. For RS232 hardware, the values RS232/DCE and RS232/AUTO are valid only with RS232 serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware. When this feature is not supported, RS232/DTE is the only valid value."
1997
  // STOP ATTRIBUTE
1998
  attribute: "Break State"
1999
    "Serial Settings:Modem Line Settings:Break State"
2000
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF01BC
2001
    // const: VI_ATTR_ASRL_BREAK_STATE
2002
    "Sets manual control of the serial port's break state. If asserted, this property suspends character transmission and places the transmission line in a break state until this property is unasserted. If you want VISA to send a break signal after each write operation automatically, use the Break Length (Break Len) and End Mode for Writes (ASRL End Out) properties instead. The default is Unasserted."
2003
  // STOP ATTRIBUTE
2004
  attribute: "CTS State"
2005
    "Serial Settings:Modem Line Settings:Line CTS State"
2006
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF00AE
2007
    // const: VI_ATTR_ASRL_CTS_STATE
2008
    "Returns the current state of the Clear To Send (CTS) input signal."
2009
  // STOP ATTRIBUTE
2010
  attribute: "DCD State"
2011
    "Serial Settings:Modem Line Settings:Line DCD State"
2012
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00AF
2013
    // const: VI_ATTR_ASRL_DCD_STATE
2014
    "Specifies the current state of the Data Carrier Detect (DCD) input signal. This is often used by modems to indicate the detection of a carrier (modem) on the phone line. This signal is also known as Receive Line Signal Detect (RLSD). This property is read only except when the Wire Mode property is set to RS232/DCE, or RS232/AUTO with the hardware currently in the DCE state."
2015
  // STOP ATTRIBUTE
2016
  attribute: "DSR State"
2017
    "Serial Settings:Modem Line Settings:Line DSR State"
2018
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF00B1
2019
    // const: VI_ATTR_ASRL_DSR_STATE
2020
    "Returns the current state of the Data Set Ready (DSR) input signal."
2021
  // STOP ATTRIBUTE
2022
  attribute: "DTR State"
2023
    "Serial Settings:Modem Line Settings:Line DTR State"
2024
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00B2
2025
    // const: VI_ATTR_ASRL_DTR_STATE
2026
    "Asserts or unasserts the Data Terminal Ready (DTR) output signal manually."
2027
  // STOP ATTRIBUTE
2028
  attribute: "RI State"
2029
    "Serial Settings:Modem Line Settings:Line RI State"
2030
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00BF
2031
    // const: VI_ATTR_ASRL_RI_STATE
2032
    "Specifies the current state of the Ring Indicator (RI) input signal. The RI signal is often used by modems to indicate that the telephone line is ringing. This property is read only except when the Wire Mode property is set to RS232/DCE or to RS232/AUTO with the hardware currently in the DCE state."
2033
  // STOP ATTRIBUTE
2034
  attribute: "RTS State"
2035
    "Serial Settings:Modem Line Settings:Line RTS State"
2036
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readwrite 00000000 3FFF00C0
2037
    // const: VI_ATTR_ASRL_RTS_STATE
2038
    "Asserts or unasserts the Request To Send (RTS) output signal manually. When the flow control is set to hardware handshaking, it is invalid to change this property."
2039
  // STOP ATTRIBUTE
2040
  attribute: "Is Connected"
2041
    "Serial Settings:Is Port Connected"
2042
    bool readonly 00000000 3FFF01BB
2043
    // const: VI_ATTR_ASRL_CONNECTED
2044
    "Returns whether the port is properly connected to another port or device. This property is valid only with serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware."
2045
  // STOP ATTRIBUTE
2046
  // STOP ATTRIBUTE LIST
2047

    
2048
  method: "VISA Read" noInvoke
2049
  method: "VISA Write" noInvoke
2050
  method: "VISA Read To File" noInvoke
2051
  method: "VISA Write From File" noInvoke
2052
  method: "VISA Clear" noInvoke
2053
  method: "VISA Read STB" noInvoke
2054
  method: "VISA Assert Trigger" noInvoke
2055
  method: "VISA Set I/O Buffer Size" noInvoke
2056
  method: "VISA Flush I/O Buffer" noInvoke
2057

    
2058
// STOP CLASS
2059

    
2060
class: "TCP/IP Instr"
2061
super: "I/O Session"
2062
sorted: no
2063
classString: "TCPIP?*::INSTR"
2064
  attribute: "TermChar"
2065
    "Message Based Settings:Termination Character"
2066
    uB readwrite 80000000 3FFF0018
2067
    // const: VI_ATTR_TERMCHAR
2068
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
2069
  // STOP ATTRIBUTE
2070
  attribute: "TermChar En"
2071
    "Message Based Settings:Termination Character Enable"
2072
    bool readwrite 80000000 3FFF0038
2073
    // const: VI_ATTR_TERMCHAR_EN
2074
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
2075
  // STOP ATTRIBUTE
2076
  attribute: "Send End En"
2077
    "Message Based Settings:Send End Enable"
2078
    bool readwrite 80000000 3FFF0016
2079
    // const: VI_ATTR_SEND_END_EN
2080
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
2081

    
2082
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
2083

    
2084
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
2085
  // STOP ATTRIBUTE
2086
  attribute: "File Append En"
2087
    "Message Based Settings:File Append Enable"
2088
    bool readwrite 80000000 3FFF0192
2089
    // const: VI_ATTR_FILE_APPEND_EN
2090
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
2091
  // STOP ATTRIBUTE
2092
  attribute: "TCP Addr"
2093
    "TCP/IP Settings:Dot-Notation Address"
2094
    string readonly 00000000 BFFF0195
2095
    // const: VI_ATTR_TCPIP_ADDR
2096
    "Returns the TCPIP address of the device to which the session is connected. This string is formatted in dot notation."
2097
  // STOP ATTRIBUTE
2098
  attribute: "TCP Hostname"
2099
    "TCP/IP Settings:Computer Hostname"
2100
    string readonly 00000000 BFFF0196
2101
    // const: VI_ATTR_TCPIP_HOSTNAME
2102
    "Returns the host name of the device. If no host name is available, this property returns an empty string."
2103
  // STOP ATTRIBUTE
2104
  attribute: "TCP NoDelay"
2105
    "TCP/IP Settings:No Packet Delay"
2106
    bool readwrite 80000000 3FFF019A
2107
    // const: VI_ATTR_TCPIP_NODELAY
2108
    "Specifies whether the Nagle algorithm is enabled. The Nagle algorithm is disabled when this property is TRUE (and vice versa). The Nagle algorithm improves network performance by buffering written data until a full-size packet can be sent. This property is TRUE by default in VISA to verify that writes get flushed immediately."
2109
  // STOP ATTRIBUTE
2110
  attribute: "TCP KeepAlive"
2111
    "TCP/IP Settings:Keep-Alive Packets"
2112
    bool readwrite 80000000 3FFF019B
2113
    // const: VI_ATTR_TCPIP_KEEPALIVE
2114
    "Specifies whether to use keep-alive packets on TCP connections. Setting this property to TRUE requests that a TCP/IP provider enable the use of keep-alive packets on TCP connections. After the system detects a dropped connection, VISA returns a lost connection error code on subsequent I/O calls on the session. The time required for the system to detect the dropped connection depends on the system and is not settable. The default is FALSE."
2115
  // STOP ATTRIBUTE
2116
  attribute: "TCP DevName"
2117
    "TCP/IP Settings:LAN Device Name"
2118
    string readonly 00000000 BFFF0199
2119
    // const: VI_ATTR_TCPIP_DEVICE_NAME
2120
    "Returns the LAN device name used by the VXI-11 protocol (for example, inst0) during connection."
2121
  // STOP ATTRIBUTE
2122
  // STOP ATTRIBUTE LIST
2123

    
2124
  method: "VISA Read" noInvoke
2125
  method: "VISA Write" noInvoke
2126
  method: "VISA Read To File" noInvoke
2127
  method: "VISA Write From File" noInvoke
2128
  method: "VISA Clear" noInvoke
2129
  method: "VISA Read STB" noInvoke
2130
  method: "VISA Assert Trigger" noInvoke
2131
  method: "VISA Set I/O Buffer Size" noInvoke
2132
  method: "VISA Flush I/O Buffer" noInvoke
2133

    
2134
// STOP CLASS
2135

    
2136
class: "USB Instr"
2137
super: "I/O Session"
2138
sorted: no
2139
classString: "USB?*::INSTR"
2140
  attribute: "Manf Name"
2141
    "General Settings:Manufacturer Name"
2142
    string readonly 00000000 BFFF0072
2143
    // const: VI_ATTR_MANF_NAME
2144
    "Returns the name of the manufacturer that created the device.
2145

    
2146
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
2147
  // STOP ATTRIBUTE
2148
  attribute: "Model Name"
2149
    "General Settings:Model Name"
2150
    string readonly 00000000 BFFF0077
2151
    // const: VI_ATTR_MODEL_NAME
2152
    "Returns the model name of the device. 
2153

    
2154
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
2155
  // STOP ATTRIBUTE
2156
  attribute: "Manf Id"
2157
    "General Settings:Manufacturer Identification"
2158
    uW readonly 00000000 3FFF00D9
2159
    // const: VI_ATTR_MANF_ID
2160
    "Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID)."
2161
  // STOP ATTRIBUTE
2162
  attribute: "Model Code"
2163
    "General Settings:Model Code"
2164
    uW readonly 00000000 3FFF00DF
2165
    // const: VI_ATTR_MODEL_CODE
2166
    "Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID)."
2167
  // STOP ATTRIBUTE
2168
  attribute: "TermChar"
2169
    "Message Based Settings:Termination Character"
2170
    uB readwrite 80000000 3FFF0018
2171
    // const: VI_ATTR_TERMCHAR
2172
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
2173
  // STOP ATTRIBUTE
2174
  attribute: "TermChar En"
2175
    "Message Based Settings:Termination Character Enable"
2176
    bool readwrite 80000000 3FFF0038
2177
    // const: VI_ATTR_TERMCHAR_EN
2178
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
2179
  // STOP ATTRIBUTE
2180
  attribute: "Send End En"
2181
    "Message Based Settings:Send End Enable"
2182
    bool readwrite 80000000 3FFF0016
2183
    // const: VI_ATTR_SEND_END_EN
2184
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
2185

    
2186
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
2187

    
2188
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
2189
  // STOP ATTRIBUTE
2190
  attribute: "Is 488.2"
2191
    "Message Based Settings:Is 488.2 Compliant"
2192
    bool readonly 00000000 3FFF019F
2193
    // const: VI_ATTR_4882_COMPLIANT
2194
    "Returns whether the device is 488.2 compliant."
2195
  // STOP ATTRIBUTE
2196
  attribute: "IO Prot"
2197
    "Message Based Settings:IO Protocol"
2198
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
2199
    // const: VI_ATTR_IO_PROT
2200
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
2201
  // STOP ATTRIBUTE
2202
  attribute: "USB Serial Num"
2203
    "USB Settings:Serial Number"
2204
    string readonly 00000000 BFFF01A0
2205
    // const: VI_ATTR_USB_SERIAL_NUM
2206
    "Returns the USB serial number of this device."
2207
  // STOP ATTRIBUTE
2208
  attribute: "USB Intfc Num"
2209
    "USB Settings:USB Interface Number"
2210
    iW readonly 00000000 3FFF01A1
2211
    // const: VI_ATTR_USB_INTFC_NUM
2212
    "Returns the USB interface number used by the given session."
2213
  // STOP ATTRIBUTE
2214
  attribute: "USB Prot"
2215
    "USB Settings:USB Protocol"
2216
    iW readonly 00000000 3FFF01A7
2217
    // const: VI_ATTR_USB_PROTOCOL
2218
    "Returns the USB protocol used by the given session."
2219
  // STOP ATTRIBUTE
2220
  attribute: "USB Max Intr Size"
2221
    "USB Settings:Maximum Interrupt Size"
2222
    uW readwrite 80000000 3FFF01AF
2223
    // const: VI_ATTR_USB_MAX_INTR_SIZE
2224
    "Specifies the maximum size of data stored by any given USB interrupt. If a USB interrupt contains more data than this size, the data in excess of this size is lost. This property is read/write when the corresponding session is not enabled to receive USB interrupt events. When the session is enabled to receive USB interrupt events, this property is read only."
2225
  // STOP ATTRIBUTE
2226
  // STOP ATTRIBUTE LIST
2227

    
2228
  method: "VISA Read" noInvoke
2229
  method: "VISA Write" noInvoke
2230
  method: "VISA Read To File" noInvoke
2231
  method: "VISA Write From File" noInvoke
2232
  method: "VISA Clear" noInvoke
2233
  method: "VISA Read STB" noInvoke
2234
  method: "VISA Assert Trigger" noInvoke
2235
  method: "VISA GPIB Control REN" noInvoke
2236
  method: "VISA USB Control Out" noInvoke
2237
  method: "VISA USB Control In" noInvoke
2238

    
2239
// STOP CLASS
2240

    
2241
// There are other I/O classes (MEMACC, INTFC, BACKPLANE, SERVANT, SOCKET)
2242

    
2243
class: "VXI/GPIB-VXI/VME MemAcc"
2244
super: "I/O Session"
2245
sorted: no
2246
classString: "?*VXI?*::MEMACC"
2247
  attribute: "Allow DMA"
2248
    "General Settings:Allow DMA Transfers"
2249
    bool readwrite 80000000 3FFF001E
2250
    // const: VI_ATTR_DMA_ALLOW_EN
2251
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
2252
  // STOP ATTRIBUTE
2253
  attribute: "Primary Addr"
2254
    "GPIB Settings:Primary Address"
2255
    uW readonly 00000000 3FFF0172
2256
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
2257
    "Returns the primary address of the GPIB controller used by the given session."
2258
  // STOP ATTRIBUTE
2259
  attribute: "Secondary Addr"
2260
    "GPIB Settings:Secondary Address"
2261
    uW readonly 00000000 3FFF0173
2262
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
2263
    "Returns the secondary address of the GPIB controller used by the given session. If the controller does not have a secondary address, the value of this property is 65535 (0xFFFF)."
2264
  // STOP ATTRIBUTE
2265
  attribute: "REN State"
2266
    "GPIB Settings:Line REN State"
2267
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
2268
    // const: VI_ATTR_GPIB_REN_STATE
2269
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
2270
  // STOP ATTRIBUTE
2271
  attribute: "Win Base Addr"
2272
    "Register Based Settings:Window Base Address"
2273
    uL readonly 80000000 3FFF0098
2274
    // const: VI_ATTR_WIN_BASE_ADDR
2275
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
2276
  // STOP ATTRIBUTE
2277
  attribute: "Win Size"
2278
    "Register Based Settings:Window Size"
2279
    uL readonly 80000000 3FFF009A
2280
    // const: VI_ATTR_WIN_SIZE
2281
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
2282
  // STOP ATTRIBUTE
2283
  attribute: "Win Access"
2284
    "Register Based Settings:Window Access"
2285
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
2286
    // const: VI_ATTR_WIN_ACCESS
2287
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
2288
  // STOP ATTRIBUTE
2289
  attribute: "Src Increment"
2290
    "Register Based Settings:Source Increment Count"
2291
    iL readwrite 80000000 3FFF0040
2292
    // const: VI_ATTR_SRC_INCREMENT
2293
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
2294
  // STOP ATTRIBUTE
2295
  attribute: "Dest Increment"
2296
    "Register Based Settings:Destination Increment Count"
2297
    iL readwrite 80000000 3FFF0041
2298
    // const: VI_ATTR_DEST_INCREMENT
2299
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
2300
  // STOP ATTRIBUTE
2301
  attribute: "VXI LA"
2302
    "VXI/VME Settings:VXI Logical Address"
2303
    iW readonly 00000000 3FFF00D5
2304
    // const: VI_ATTR_VXI_LA
2305
    "Returns the logical address of the local VXI controller."
2306
  // STOP ATTRIBUTE
2307
  attribute: "Src Access Priv"
2308
    "VXI/VME Settings:Source Access Privilege"
2309
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF003C
2310
    // const: VI_ATTR_SRC_ACCESS_PRIV
2311
    "Specifies the address modifier to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Data/Privileged (0)."
2312
  // STOP ATTRIBUTE
2313
  attribute: "Dest Access Priv"
2314
    "VXI/VME Settings:Destination Access Privilege"
2315
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0039
2316
    // const: VI_ATTR_DEST_ACCESS_PRIV
2317
    "Specifies the address modifier to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Data/Privileged (0)."
2318
  // STOP ATTRIBUTE
2319
  attribute: "Win Access Priv"
2320
    "VXI/VME Settings:Window Access Privilege"
2321
    uW enum {Data/Privileged=0, Data/NonPrivileged=1, Program/Privileged=2, Program/NonPrivileged=3, Block/Privileged=4, Block/NonPrivileged=5, D64/Privileged=6, D64/NonPrivileged=7} readwrite 80000000 3FFF0045
2322
    // const: VI_ATTR_WIN_ACCESS_PRIV
2323
    "Specifies the address modifier to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Data/Privileged (0)."
2324
  // STOP ATTRIBUTE
2325
  attribute: "Src Byte Order"
2326
    "VXI/VME Settings:Source Byte Order"
2327
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003D
2328
    // const: VI_ATTR_SRC_BYTE_ORDER
2329
    "Specifies the byte order to use in high-level access operations, such as VISA In X and VISA Move In X, when reading from the source. The default is Big Endian (0)."
2330
  // STOP ATTRIBUTE
2331
  attribute: "Dest Byte Order"
2332
    "VXI/VME Settings:Destination Byte Order"
2333
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF003A
2334
    // const: VI_ATTR_DEST_BYTE_ORDER
2335
    "Specifies the byte order to use in high-level access operations, such as VISA Out X and VISA Move Out X, when writing to the destination. The default is Big Endian (0)."
2336
  // STOP ATTRIBUTE
2337
  attribute: "Win Byte Order"
2338
    "VXI/VME Settings:Window Byte Order"
2339
    uW enum {"Big Endian"=0, "Little Endian"=1} readwrite 80000000 3FFF0047
2340
    // const: VI_ATTR_WIN_BYTE_ORDER
2341
    "Specifies the byte order to use in low-level access operations, such as VISA Map Address, VISA Peek X, and VISA Poke X, when accessing the mapped window. The default is Big Endian (0)."
2342
  // STOP ATTRIBUTE
2343
  attribute: "Intf Parent Num"
2344
    "Interface Information:Interface Number of Parent"
2345
    uW readonly 00000000 3FFF0101
2346
    // const: VI_ATTR_INTF_PARENT_NUM
2347
    "Returns the board number of the parent device."
2348
  // STOP ATTRIBUTE
2349
  // STOP ATTRIBUTE LIST
2350

    
2351
  method: "VISA In 64" noInvoke
2352
  method: "VISA In 32" noInvoke
2353
  method: "VISA In 16" noInvoke
2354
  method: "VISA In 8" noInvoke
2355
  method: "VISA Out 64" noInvoke
2356
  method: "VISA Out 32" noInvoke
2357
  method: "VISA Out 16" noInvoke
2358
  method: "VISA Out 8" noInvoke
2359
  method: "VISA Map Address" noInvoke
2360
  method: "VISA Unmap Address" noInvoke
2361
  method: "VISA Peek 64" noInvoke
2362
  method: "VISA Peek 32" noInvoke
2363
  method: "VISA Peek 16" noInvoke
2364
  method: "VISA Peek 8" noInvoke
2365
  method: "VISA Poke 64" noInvoke
2366
  method: "VISA Poke 32" noInvoke
2367
  method: "VISA Poke 16" noInvoke
2368
  method: "VISA Poke 8" noInvoke
2369
  method: "VISA Move" noInvoke
2370
  method: "VISA Move In 8" noInvoke
2371
  method: "VISA Move In 16" noInvoke
2372
  method: "VISA Move In 32" noInvoke
2373
  method: "VISA Move In 64" noInvoke
2374
  method: "VISA Move Out 8" noInvoke
2375
  method: "VISA Move Out 16" noInvoke
2376
  method: "VISA Move Out 32" noInvoke
2377
  method: "VISA Move Out 64" noInvoke
2378

    
2379
// STOP CLASS
2380

    
2381
class: "PXI MemAcc"
2382
super: "I/O Session"
2383
sorted: no
2384
classString: "PXI?*::MEMACC"
2385
  attribute: "Win Base Addr"
2386
    "Register Based Settings:Window Base Address"
2387
    uL readonly 80000000 3FFF0098
2388
    // const: VI_ATTR_WIN_BASE_ADDR
2389
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
2390
  // STOP ATTRIBUTE
2391
  attribute: "Win Size"
2392
    "Register Based Settings:Window Size"
2393
    uL readonly 80000000 3FFF009A
2394
    // const: VI_ATTR_WIN_SIZE
2395
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
2396
  // STOP ATTRIBUTE
2397
  attribute: "Win Access"
2398
    "Register Based Settings:Window Access"
2399
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
2400
    // const: VI_ATTR_WIN_ACCESS
2401
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
2402
  // STOP ATTRIBUTE
2403
  attribute: "Src Increment"
2404
    "Register Based Settings:Source Increment Count"
2405
    iL readwrite 80000000 3FFF0040
2406
    // const: VI_ATTR_SRC_INCREMENT
2407
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
2408
  // STOP ATTRIBUTE
2409
  attribute: "Dest Increment"
2410
    "Register Based Settings:Destination Increment Count"
2411
    iL readwrite 80000000 3FFF0041
2412
    // const: VI_ATTR_DEST_INCREMENT
2413
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
2414
  // STOP ATTRIBUTE
2415
  // STOP ATTRIBUTE LIST
2416

    
2417
  method: "VISA In 64" noInvoke
2418
  method: "VISA In 32" noInvoke
2419
  method: "VISA In 16" noInvoke
2420
  method: "VISA In 8" noInvoke
2421
  method: "VISA Out 64" noInvoke
2422
  method: "VISA Out 32" noInvoke
2423
  method: "VISA Out 16" noInvoke
2424
  method: "VISA Out 8" noInvoke
2425
  method: "VISA Map Address" noInvoke
2426
  method: "VISA Unmap Address" noInvoke
2427
  method: "VISA Peek 64" noInvoke
2428
  method: "VISA Peek 32" noInvoke
2429
  method: "VISA Peek 16" noInvoke
2430
  method: "VISA Peek 8" noInvoke
2431
  method: "VISA Poke 64" noInvoke
2432
  method: "VISA Poke 32" noInvoke
2433
  method: "VISA Poke 16" noInvoke
2434
  method: "VISA Poke 8" noInvoke
2435
  method: "VISA Move In 8" noInvoke
2436
  method: "VISA Move In 16" noInvoke
2437
  method: "VISA Move In 32" noInvoke
2438
  method: "VISA Move In 64" noInvoke
2439
  method: "VISA Move Out 8" noInvoke
2440
  method: "VISA Move Out 16" noInvoke
2441
  method: "VISA Move Out 32" noInvoke
2442
  method: "VISA Move Out 64" noInvoke
2443
  method: "VISA Mem Alloc" noInvoke
2444
  method: "VISA Memory Allocation Ex" noInvoke
2445
  method: "VISA Mem Free" noInvoke
2446

    
2447
// STOP CLASS
2448

    
2449
class: "VXI/GPIB-VXI Backplane"
2450
super: "I/O Session"
2451
sorted: no
2452
classString: "?*VXI?*::BACKPLANE"
2453
  attribute: "Trigger Id"
2454
    "General Settings:Trigger Identifier"
2455
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readwrite 80000000 3FFF0177
2456
    // const: VI_ATTR_TRIG_ID
2457
    "Specifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software."
2458
  // STOP ATTRIBUTE
2459
  attribute: "Primary Addr"
2460
    "GPIB Settings:Primary Address"
2461
    uW readonly 00000000 3FFF0172
2462
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
2463
    "Returns the primary address of the GPIB device used by the given session."
2464
  // STOP ATTRIBUTE
2465
  attribute: "Secondary Addr"
2466
    "GPIB Settings:Secondary Address"
2467
    uW readonly 00000000 3FFF0173
2468
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
2469
    "Returns the secondary address of the GPIB device used by the given session. If the device does not have a secondary address, the value of this property is 65535 (0xFFFF)."
2470
  // STOP ATTRIBUTE
2471
  attribute: "Mainframe LA"
2472
    "VXI/VME Settings:Mainframe Logical Address"
2473
    iW readonly 00000000 3FFF0070
2474
    // const: VI_ATTR_MAINFRAME_LA
2475
    "Returns the lowest logical address in the mainframe in which the device resides."
2476
  // STOP ATTRIBUTE
2477
  attribute: "VXI Trig Supp"
2478
    "VXI/VME Settings:Supported VXI Trigger Lines"
2479
    uL readonly 00000000 3FFF0194
2480
    // const: VI_ATTR_VXI_TRIG_SUPPORT
2481
    "Returns which VXI trigger lines this implementation supports. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1."
2482
  // STOP ATTRIBUTE
2483
  attribute: "VXI Trig Status"
2484
    "VXI/VME Settings:Asserted VXI Trigger Lines"
2485
    uL readonly 00000000 3FFF008D
2486
    // const: VI_ATTR_VXI_TRIG_STATUS
2487
    "Returns the current state of the VXI trigger lines. This property returns a bit vector with bits 0-9 corresponding to TTL0 through ECL1."
2488
  // STOP ATTRIBUTE
2489
  attribute: "VXI/VME Interrupt Status"
2490
    "VXI/VME Settings:Asserted VXI/VME Interrupt Lines"
2491
    uL readonly 00000000 3FFF008B
2492
    // const: VI_ATTR_VXI_VME_INTR_STATUS
2493
    "Returns the current state of the VXI/VME interrupt lines. This property returns a bit vector with bits 0-6 corresponding to interrupt lines 1-7."
2494
  // STOP ATTRIBUTE
2495
  attribute: "VXI/VME Sysfail State"
2496
    "VXI/VME Settings:VXI/VME System Failure State"
2497
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0094
2498
    // const: VI_ATTR_VXI_VME_SYSFAIL_STATE
2499
    "Returns the current state of the VXI/VME SYSFAIL (SYStem FAILure) backplane line."
2500
  // STOP ATTRIBUTE
2501
  attribute: "Intf Parent Num"
2502
    "Interface Information:Interface Number of Parent"
2503
    uW readonly 00000000 3FFF0101
2504
    // const: VI_ATTR_INTF_PARENT_NUM
2505
    "Returns the board number of the parent device."
2506
  // STOP ATTRIBUTE
2507
  // STOP ATTRIBUTE LIST
2508

    
2509
  method: "VISA Assert Trigger" noInvoke
2510
  method: "VISA Assert Interrupt Signal" noInvoke
2511
  method: "VISA Assert Utility Signal" noInvoke
2512
  method: "VISA Map Trigger" noInvoke
2513
  method: "VISA Unmap Trigger" noInvoke
2514

    
2515
// STOP CLASS
2516

    
2517
class: "PXI Backplane"
2518
super: "I/O Session"
2519
sorted: no
2520
classString: "PXI?*::BACKPLANE"
2521
  attribute: "Manf Name"
2522
    "General Settings:Manufacturer Name"
2523
    string readonly 00000000 BFFF0072
2524
    // const: VI_ATTR_MANF_NAME
2525
    "Returns the name of the manufacturer that created the device.
2526

    
2527
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
2528
  // STOP ATTRIBUTE
2529
  attribute: "Model Name"
2530
    "General Settings:Model Name"
2531
    string readonly 00000000 BFFF0077
2532
    // const: VI_ATTR_MODEL_NAME
2533
    "Returns the model name of the device. 
2534

    
2535
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
2536
  // STOP ATTRIBUTE
2537
  attribute: "Chassis Num"
2538
    "PXI/PCI Settings:PXI Chassis Number"
2539
    iW readonly 00000000 3FFF0206
2540
    // const: VI_ATTR_PXI_CHASSIS
2541
    "Returns the PXI chassis number of this resource. A value of -1 means the chassis number is unknown. Other valid values are 0 to 255."
2542
  // STOP ATTRIBUTE
2543
  attribute: "Trig Bus"
2544
    "PXI/PCI Settings:Trigger Bus Number"
2545
    iW readwrite 80000000 3FFF020A
2546
    // const: VI_ATTR_PXI_TRIG_BUS
2547
    "Specifies the trigger bus number of this device."
2548
  // STOP ATTRIBUTE
2549
  attribute: "Src Trig Bus"
2550
    "PXI/PCI Settings:Source Trigger Bus Number"
2551
    iW readwrite 80000000 3FFF020D
2552
    // const: VI_ATTR_PXI_SRC_TRIG_BUS
2553
    "Specifies the segment to use to qualify the trigger source in VISA Map Trigger.
2554

    
2555
<B>Note:</B> Some PXI chassis, typically those with more than eight slots, have multiple trigger buses (also called segments). The PXI Backplane resource uses the VISA Map Trigger to map a trigger between two trigger buses. One trigger bus, specified by Source Trigger Bus Number, is the source or writer for this trigger line. The other trigger bus, specified by Destination Trigger Bus Number, is a reader. You can have multiple readers, but only one writer for a given trigger line. 
2556

    
2557
For example, if you want to have triggers mapped from trigger bus 1 to trigger bus 2 and then from trigger bus 2 to trigger bus 3. In this case trigger bus 1 is the writer for this line, writing to both trigger bus 2 and trigger bus 3. Therefore, you should perform VISA Map Trigger from 1 to 2 and from 1 to 3. Mapping from 1 to 2 and then 2 to 3 would not be allowed because it would require 2 to be a writer (as well as 1). Note also that mapping from one line in the source trigger bus to a different line in the destination trigger bus is dependent on hardware capabilities and a specific software implementation. This behavior might not be supported.
2558

    
2559
A value of -1 means this feature is not enabled or not applicable.  On a single-segment chassis (eight slots or less), this feature is not applicable.  For a multi-segment chassis (more than eight slots), the valid values are 1 to the number of chassis segments. You can determine the number of segments from MAX (in the trigger reservation panel), from the chassis documentation, and by looking at the dividing lines on the physical front panel of the chassis itself. The default is -1."
2560
  // STOP ATTRIBUTE
2561
  attribute: "Dest Trig Bus"
2562
    "PXI/PCI Settings:Destination Trigger Bus Number"
2563
    iW readwrite 80000000 3FFF020E
2564
    // const: VI_ATTR_PXI_DEST_TRIG_BUS
2565
    "Specifies the segment to use to qualify the trigger destination in VISA Map Trigger.
2566

    
2567
<B>Note:</B> Some PXI chassis, typically those with more than eight slots, have multiple trigger buses (also called segments). The PXI Backplane resource uses the VISA Map Trigger to map a trigger between two trigger buses. One trigger bus, specified by Source Trigger Bus Number, is the source or writer for this trigger line. The other trigger bus, specified by Destination Trigger Bus Number, is a reader. You can have multiple readers, but only one writer for a given trigger line. 
2568

    
2569
For example, if you want to have triggers mapped from trigger bus 1 to trigger bus 2 and then from trigger bus 2 to trigger bus 3. In this case trigger bus 1 is the writer for this line, writing to both trigger bus 2 and trigger bus 3. Therefore, you should perform VISA Map Trigger from 1 to 2 and from 1 to 3. Mapping from 1 to 2 and then 2 to 3 would not be allowed because it would require 2 to be a writer (as well as 1). Note also that mapping from one line in the source trigger bus to a different line in the destination trigger bus is dependent on hardware capabilities and a specific software implementation. This behavior might not be supported.
2570

    
2571
A value of -1 means this feature is not enabled or not applicable.  On a single-segment chassis (eight slots or less), this feature is not applicable.  For a multi-segment chassis (more than eight slots), the valid values are 1 to the number of chassis segments. You can determine the number of segments from MAX (in the trigger reservation panel), from the chassis documentation, and by looking at the dividing lines on the physical front panel of the chassis itself."
2572
  // STOP ATTRIBUTE
2573
  attribute: "Trigger Id"
2574
    "General Settings:Trigger Identifier"
2575
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readwrite 80000000 3FFF0177
2576
    // const: VI_ATTR_TRIG_ID
2577
    "Specifies which trigger mechanism to use. In VXI systems, for example, you can choose between software triggers and hardware triggers on a specific trigger line. The default is Software."
2578
  // STOP ATTRIBUTE
2579
  // STOP ATTRIBUTE LIST
2580

    
2581
  method: "VISA Assert Trigger" noInvoke
2582
  method: "VISA Map Trigger" noInvoke
2583
  method: "VISA Unmap Trigger" noInvoke
2584

    
2585
// STOP CLASS
2586

    
2587
class: "VXI Servant"
2588
super: "I/O Session"
2589
sorted: no
2590
classString: "?*VXI?*::SERVANT"
2591
  attribute: "Allow DMA"
2592
    "General Settings:Allow DMA Transfers"
2593
    bool readwrite 80000000 3FFF001E
2594
    // const: VI_ATTR_DMA_ALLOW_EN
2595
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
2596
  // STOP ATTRIBUTE
2597
  attribute: "TermChar"
2598
    "Message Based Settings:Termination Character"
2599
    uB readwrite 80000000 3FFF0018
2600
    // const: VI_ATTR_TERMCHAR
2601
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
2602
  // STOP ATTRIBUTE
2603
  attribute: "TermChar En"
2604
    "Message Based Settings:Termination Character Enable"
2605
    bool readwrite 80000000 3FFF0038
2606
    // const: VI_ATTR_TERMCHAR_EN
2607
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
2608
  // STOP ATTRIBUTE
2609
  attribute: "Send End En"
2610
    "Message Based Settings:Send End Enable"
2611
    bool readwrite 80000000 3FFF0016
2612
    // const: VI_ATTR_SEND_END_EN
2613
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
2614

    
2615
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
2616

    
2617
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
2618
  // STOP ATTRIBUTE
2619
  attribute: "Device STB"
2620
    "Message Based Settings:Device Status Byte"
2621
    uB readwrite 00000000 3FFF0189
2622
    // const: VI_ATTR_DEV_STATUS_BYTE
2623
    "Specifies the 488-style status byte of the local controller or device associated with this session. If you write this property and set bit 6 (0x40), this device or controller asserts a service request (SRQ) on the interface."
2624
  // STOP ATTRIBUTE
2625
  attribute: "File Append En"
2626
    "Message Based Settings:File Append Enable"
2627
    bool readwrite 80000000 3FFF0192
2628
    // const: VI_ATTR_FILE_APPEND_EN
2629
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
2630
  // STOP ATTRIBUTE
2631
  attribute: "Cmdr LA"
2632
    "VXI/VME Settings:VXI Commander Logical Address"
2633
    iW readonly 00000000 3FFF006B
2634
    // const: VI_ATTR_CMDR_LA
2635
    "Returns the logical address of the commander of the VXI device."
2636
  // STOP ATTRIBUTE
2637
  attribute: "VXI LA"
2638
    "VXI/VME Settings:VXI Logical Address"
2639
    iW readonly 00000000 3FFF00D5
2640
    // const: VI_ATTR_VXI_LA
2641
    "Returns the logical address of the VXI device."
2642
  // STOP ATTRIBUTE
2643
  attribute: "VXI/VME Sysfail State"
2644
    "VXI/VME Settings:VXI/VME System Failure State"
2645
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0094
2646
    // const: VI_ATTR_VXI_VME_SYSFAIL_STATE
2647
    "Returns the current state of the VXI/VME SYSFAIL (SYStem FAILure) backplane line."
2648
  // STOP ATTRIBUTE
2649
  // STOP ATTRIBUTE LIST
2650

    
2651
  method: "VISA Read" noInvoke
2652
  method: "VISA Write" noInvoke
2653
  method: "VISA Read To File" noInvoke
2654
  method: "VISA Write From File" noInvoke
2655
  method: "VISA Assert Interrupt Signal" noInvoke
2656
  method: "VISA Assert Utility Signal" noInvoke
2657

    
2658
// STOP CLASS
2659

    
2660
class: "GPIB BoardInterface"
2661
super: "I/O Session"
2662
sorted: no
2663
classString: "GPIB?*::INTFC"
2664
  attribute: "Allow DMA"
2665
    "General Settings:Allow DMA Transfers"
2666
    bool readwrite 80000000 3FFF001E
2667
    // const: VI_ATTR_DMA_ALLOW_EN
2668
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
2669
  // STOP ATTRIBUTE
2670
  attribute: "Primary Addr"
2671
    "GPIB Settings:Primary Address"
2672
    uW readwrite 00000000 3FFF0172
2673
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
2674
    "Returns the primary address of the GPIB interface used by the given session."
2675
  // STOP ATTRIBUTE
2676
  attribute: "Secondary Addr"
2677
    "GPIB Settings:Secondary Address"
2678
    uW readwrite 00000000 3FFF0173
2679
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
2680
    "Returns the secondary address of the GPIB interface used by the given session. If the interface does not have a secondary address, the value of this property is 65535 (0xFFFF)."
2681
  // STOP ATTRIBUTE
2682
  attribute: "ATN State"
2683
    "GPIB Settings:Line ATN State"
2684
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0057
2685
    // const: VI_ATTR_GPIB_ATN_STATE
2686
    "Returns the current state of the GPIB ATN interface line."
2687
  // STOP ATTRIBUTE
2688
  attribute: "NDAC State"
2689
    "GPIB Settings:Line NDAC State"
2690
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0062
2691
    // const: VI_ATTR_GPIB_NDAC_STATE
2692
    "Returns the current state of the GPIB NDAC interface line."
2693
  // STOP ATTRIBUTE
2694
  attribute: "REN State"
2695
    "GPIB Settings:Line REN State"
2696
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
2697
    // const: VI_ATTR_GPIB_REN_STATE
2698
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
2699
  // STOP ATTRIBUTE
2700
  attribute: "SRQ State"
2701
    "GPIB Settings:Line SRQ State"
2702
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0067
2703
    // const: VI_ATTR_GPIB_SRQ_STATE
2704
    "Returns the current state of the GPIB SRQ interface line."
2705
  // STOP ATTRIBUTE
2706
  attribute: "CIC State"
2707
    "GPIB Settings:CIC State"
2708
    bool readonly 00000000 3FFF005E
2709
    // const: VI_ATTR_GPIB_CIC_STATE
2710
    "Returns whether the specified GPIB interface is currently CIC (Controller In Charge)."
2711
  // STOP ATTRIBUTE
2712
  attribute: "SysCntrl State"
2713
    "GPIB Settings:System Controller State"
2714
    bool readwrite 00000000 3FFF0068
2715
    // const: VI_ATTR_GPIB_SYS_CNTRL_STATE
2716
    "Specifies whether the specified GPIB interface is currently the system controller."
2717
  // STOP ATTRIBUTE
2718
  attribute: "Address State"
2719
    "GPIB Settings:Addressed State"
2720
    uW enum {Unaddressed=0, Talker=1, Listener=2} readonly 00000000 3FFF005C
2721
    // const: VI_ATTR_GPIB_ADDR_STATE
2722
    "Returns whether the specified GPIB interface is not addressed (0), addressed to talk (1) or addressed to listen (2)."
2723
  // STOP ATTRIBUTE
2724
  attribute: "HS488 Cbl Len"
2725
    "GPIB Settings:HS488 Cable Length"
2726
    iW readwrite 00000000 3FFF0069
2727
    // const: VI_ATTR_GPIB_HS488_CBL_LEN
2728
    "Specifies the total number of meters (1-15) of GPIB cable used in the specified GPIB interface. The value 0 means that HS488 is disabled. The value -1 means HS488 is not implemented."
2729
  // STOP ATTRIBUTE
2730
  attribute: "TermChar"
2731
    "Message Based Settings:Termination Character"
2732
    uB readwrite 80000000 3FFF0018
2733
    // const: VI_ATTR_TERMCHAR
2734
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
2735
  // STOP ATTRIBUTE
2736
  attribute: "TermChar En"
2737
    "Message Based Settings:Termination Character Enable"
2738
    bool readwrite 80000000 3FFF0038
2739
    // const: VI_ATTR_TERMCHAR_EN
2740
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
2741
  // STOP ATTRIBUTE
2742
  attribute: "Send End En"
2743
    "Message Based Settings:Send End Enable"
2744
    bool readwrite 80000000 3FFF0016
2745
    // const: VI_ATTR_SEND_END_EN
2746
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
2747

    
2748
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
2749

    
2750
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
2751
  attribute: "Device STB"
2752
    "Message Based Settings:Device Status Byte"
2753
    uB readwrite 00000000 3FFF0189
2754
    // const: VI_ATTR_DEV_STATUS_BYTE
2755
    "Specifies the 488-style status byte of the local controller or device associated with this session. If you write this property and set bit 6 (0x40), this device or controller asserts a service request (SRQ) on the interface."
2756
  // STOP ATTRIBUTE
2757
  attribute: "File Append En"
2758
    "Message Based Settings:File Append Enable"
2759
    bool readwrite 80000000 3FFF0192
2760
    // const: VI_ATTR_FILE_APPEND_EN
2761
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
2762
  // STOP ATTRIBUTE
2763
  attribute: "IO Prot"
2764
    "Message Based Settings:IO Protocol"
2765
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
2766
    // const: VI_ATTR_IO_PROT
2767
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
2768
  // STOP ATTRIBUTE
2769
  // STOP ATTRIBUTE LIST
2770

    
2771
  method: "VISA Read" noInvoke
2772
  method: "VISA Write" noInvoke
2773
  method: "VISA Read To File" noInvoke
2774
  method: "VISA Write From File" noInvoke
2775
  method: "VISA Assert Trigger" noInvoke
2776
  method: "VISA GPIB Control ATN" noInvoke
2777
  method: "VISA GPIB Control REN" noInvoke
2778
  method: "VISA GPIB Pass Control" noInvoke
2779
  method: "VISA GPIB Send IFC" noInvoke
2780
  method: "VISA GPIB Command" noInvoke
2781

    
2782
// STOP CLASS
2783

    
2784
class: "GPIB Servant"
2785
super: "I/O Session"
2786
sorted: no
2787
classString: "GPIB?*::SERVANT"
2788
  attribute: "Allow DMA"
2789
    "General Settings:Allow DMA Transfers"
2790
    bool readwrite 80000000 3FFF001E
2791
    // const: VI_ATTR_DMA_ALLOW_EN
2792
    "Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality."
2793
  // STOP ATTRIBUTE
2794
  attribute: "Primary Addr"
2795
    "GPIB Settings:Primary Address"
2796
    uW readwrite 00000000 3FFF0172
2797
    // const: VI_ATTR_GPIB_PRIMARY_ADDR
2798
    "Returns the primary address of the GPIB interface used by the given session."
2799
  // STOP ATTRIBUTE
2800
  attribute: "Secondary Addr"
2801
    "GPIB Settings:Secondary Address"
2802
    uW readwrite 00000000 3FFF0173
2803
    // const: VI_ATTR_GPIB_SECONDARY_ADDR
2804
    "Returns the secondary address of the GPIB interface used by the given session. If the interface does not have a secondary address, the value of this property is 65535 (0xFFFF)."
2805
  // STOP ATTRIBUTE
2806
  attribute: "REN State"
2807
    "GPIB Settings:Line REN State"
2808
    iW enum {Unknown=-1, Unasserted=0, Asserted=1} readonly 00000000 3FFF0181
2809
    // const: VI_ATTR_GPIB_REN_STATE
2810
    "Returns the current state of the GPIB REN (Remote ENable) interface line."
2811
  // STOP ATTRIBUTE
2812
  attribute: "TermChar"
2813
    "Message Based Settings:Termination Character"
2814
    uB readwrite 80000000 3FFF0018
2815
    // const: VI_ATTR_TERMCHAR
2816
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
2817
  // STOP ATTRIBUTE
2818
  attribute: "TermChar En"
2819
    "Message Based Settings:Termination Character Enable"
2820
    bool readwrite 80000000 3FFF0038
2821
    // const: VI_ATTR_TERMCHAR_EN
2822
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
2823
  // STOP ATTRIBUTE
2824
  attribute: "Send End En"
2825
    "Message Based Settings:Send End Enable"
2826
    bool readwrite 80000000 3FFF0016
2827
    // const: VI_ATTR_SEND_END_EN
2828
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
2829

    
2830
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
2831

    
2832
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
2833
  // STOP ATTRIBUTE
2834
  attribute: "Device STB"
2835
    "Message Based Settings:Device Status Byte"
2836
    uB readwrite 00000000 3FFF0189
2837
    // const: VI_ATTR_DEV_STATUS_BYTE
2838
    "Specifies the 488-style status byte of the local controller or device associated with this session. If you write this property and set bit 6 (0x40), this device or controller will assert a service request (SRQ) on the interface."
2839
  // STOP ATTRIBUTE
2840
  attribute: "File Append En"
2841
    "Message Based Settings:File Append Enable"
2842
    bool readwrite 80000000 3FFF0192
2843
    // const: VI_ATTR_FILE_APPEND_EN
2844
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
2845
  // STOP ATTRIBUTE
2846
  attribute: "IO Prot"
2847
    "Message Based Settings:IO Protocol"
2848
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
2849
    // const: VI_ATTR_IO_PROT
2850
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
2851
  // STOP ATTRIBUTE
2852
  attribute: "Address State"
2853
    "GPIB Settings:Addressed State"
2854
    uW enum {Unaddressed=0, Talker=1, Listener=2} readonly 00000000 3FFF005C
2855
    // const: VI_ATTR_GPIB_ADDR_STATE
2856
    "Returns whether the specified GPIB interface is not addressed (0), addressed to talk (1), or addressed to listen (2)."
2857
  // STOP ATTRIBUTE
2858
  attribute: "HS488 Cbl Len"
2859
    "GPIB Settings:HS488 Cable Length"
2860
    iW readwrite 00000000 3FFF0069
2861
    // const: VI_ATTR_GPIB_HS488_CBL_LEN
2862
    "Specifies the total number of meters (1-15) of GPIB cable used in the specified GPIB interface. The value 0 means that HS488 is disabled. The value -1 means HS488 is not implemented."
2863
  // STOP ATTRIBUTE
2864
  // STOP ATTRIBUTE LIST
2865

    
2866
  method: "VISA Read" noInvoke
2867
  method: "VISA Write" noInvoke
2868
  method: "VISA Read To File" noInvoke
2869
  method: "VISA Write From File" noInvoke
2870

    
2871
// STOP CLASS
2872

    
2873
class: "TCP/IP Socket"
2874
super: "I/O Session"
2875
sorted: no
2876
classString: "TCPIP?*::SOCKET"
2877
  attribute: "TermChar"
2878
    "Message Based Settings:Termination Character"
2879
    uB readwrite 80000000 3FFF0018
2880
    // const: VI_ATTR_TERMCHAR
2881
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
2882
  // STOP ATTRIBUTE
2883
  attribute: "TermChar En"
2884
    "Message Based Settings:Termination Character Enable"
2885
    bool readwrite 80000000 3FFF0038
2886
    // const: VI_ATTR_TERMCHAR_EN
2887
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
2888
  // STOP ATTRIBUTE
2889
  attribute: "Send End En"
2890
    "Message Based Settings:Send End Enable"
2891
    bool readwrite 80000000 3FFF0016
2892
    // const: VI_ATTR_SEND_END_EN
2893
    "Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE.
2894

    
2895
On Serial Instr sessions, if this property is set to FALSE, the write transmits the exact contents of the user buffer, without modifying it and without appending anything to the data. If this property is set to TRUE, VISA performs the behavior described in the Serial Settings property End Mode for Reads (ASRL End In).
2896

    
2897
On GPIB, VXI, GPIB-VXI, TCP/IP Instr, and USB Instr sessions, if this property is set to TRUE, VISA includes the 488.2 defined end of message terminator."
2898
  // STOP ATTRIBUTE
2899
  attribute: "Suppress End En"
2900
    "Message Based Settings:Suppress End Enable"
2901
    bool readwrite 80000000 3FFF0036
2902
    // const: VI_ATTR_SUPPRESS_END_EN
2903
    "Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations.
2904

    
2905
For all session types that support this property, if this property is set to TRUE, read does not terminate due to an END condition. However, a read may still terminate successfully if the Message Based Settings:Termination Character Enable (TermChar En) property is set to TRUE. Otherwise, read does not terminate until it receives all of the requested data (or an error occurs). The default is FALSE (except for TCP/IP Socket sessions).
2906

    
2907
On Serial Instr sessions, if this property is set to FALSE, VISA performs the behavior described in the Serial Settings:End Mode for Reads (ASRL End In) property.
2908

    
2909
On USB Raw sessions, if this property is set to FALSE, VISA performs the behavior described in the USB Settings:End Mode for Reads (USB End In) property.
2910

    
2911
On TCP/IP Socket sessions, if this property is set to FALSE, if NI-VISA reads some data and then detects a pause in the arrival of data packets, it terminates the read operation. On TCP/IP Socket sessions, the default value for the property is TRUE in NI-VISA.
2912

    
2913
On VXI Instr sessions, if this property is set to FALSE, the END bit terminates read operations."
2914
  // STOP ATTRIBUTE
2915
  attribute: "File Append En"
2916
    "Message Based Settings:File Append Enable"
2917
    bool readwrite 80000000 3FFF0192
2918
    // const: VI_ATTR_FILE_APPEND_EN
2919
    "Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File?overwrites (truncates) when opening a file. The default is FALSE."
2920
  // STOP ATTRIBUTE
2921
  attribute: "IO Prot"
2922
    "Message Based Settings:IO Protocol"
2923
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
2924
    // const: VI_ATTR_IO_PROT
2925
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
2926
  // STOP ATTRIBUTE
2927
  attribute: "TCP Addr"
2928
    "TCP/IP Settings:Dot-Notation Address"
2929
    string readonly 00000000 BFFF0195
2930
    // const: VI_ATTR_TCPIP_ADDR
2931
    "Returns the TCPIP address of the device to which the session is connected. This string is formatted in dot notation."
2932
  // STOP ATTRIBUTE
2933
  attribute: "TCP Hostname"
2934
    "TCP/IP Settings:Computer Hostname"
2935
    string readonly 00000000 BFFF0196
2936
    // const: VI_ATTR_TCPIP_HOSTNAME
2937
    "Returns the host name of the device. If no host name is available, this property returns an empty string."
2938
  // STOP ATTRIBUTE
2939
  attribute: "TCP Port"
2940
    "TCP/IP Settings:Port Number"
2941
    uW readonly 00000000 3FFF0197
2942
    // const: VI_ATTR_TCPIP_PORT
2943
    "Returns the port number for a given TCPIP address. For a TCPIP SOCKET resource, this is a required part of the address/resource string."
2944
  // STOP ATTRIBUTE
2945
  attribute: "TCP NoDelay"
2946
    "TCP/IP Settings:No Packet Delay"
2947
    bool readwrite 80000000 3FFF019A
2948
    // const: VI_ATTR_TCPIP_NODELAY
2949
    "Specifies whether the Nagle algorithm is enabled. The Nagle algorithm is disabled when this property is TRUE (and vice versa). The Nagle algorithm improves network performance by buffering written data until a full-size packet can be sent. This property is TRUE by default in VISA to verify that writes get flushed immediately."
2950
  // STOP ATTRIBUTE
2951
  attribute: "TCP KeepAlive"
2952
    "TCP/IP Settings:Keep-Alive Packets"
2953
    bool readwrite 80000000 3FFF019B
2954
    // const: VI_ATTR_TCPIP_KEEPALIVE
2955
    "Specifies whether to use keep-alive packets on TCP connections. Setting this property to TRUE requests that a TCP/IP provider enable the use of keep-alive packets on TCP connections. After the system detects a dropped connection, VISA returns a lost connection error code on subsequent I/O calls on the session. The time required for the system to detect the dropped connection depends on the system and is not settable. The default is FALSE."
2956
  // STOP ATTRIBUTE
2957
  // STOP ATTRIBUTE LIST
2958

    
2959
  method: "VISA Read" noInvoke
2960
  method: "VISA Write" noInvoke
2961
  method: "VISA Read To File" noInvoke
2962
  method: "VISA Write From File" noInvoke
2963
  method: "VISA Clear" noInvoke
2964
  method: "VISA Read STB" noInvoke
2965
  method: "VISA Assert Trigger" noInvoke
2966
  method: "VISA Set I/O Buffer Size" noInvoke
2967
  method: "VISA Flush I/O Buffer" noInvoke
2968

    
2969
// STOP CLASS
2970

    
2971
class: "USB Raw"
2972
super: "I/O Session"
2973
sorted: no
2974
classString: "USB?*::RAW"
2975
  attribute: "Manf Name"
2976
    "General Settings:Manufacturer Name"
2977
    string readonly 00000000 BFFF0072
2978
    // const: VI_ATTR_MANF_NAME
2979
    "Returns the name of the manufacturer that created the device.
2980

    
2981
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
2982
  // STOP ATTRIBUTE
2983
  attribute: "Model Name"
2984
    "General Settings:Model Name"
2985
    string readonly 00000000 BFFF0077
2986
    // const: VI_ATTR_MODEL_NAME
2987
    "Returns the model name of the device. 
2988

    
2989
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
2990
  // STOP ATTRIBUTE
2991
  attribute: "Manf Id"
2992
    "General Settings:Manufacturer Identification"
2993
    uW readonly 00000000 3FFF00D9
2994
    // const: VI_ATTR_MANF_ID
2995
    "Returns the ID of the manufacturer that created the device. For VXI resources, this refers to the VXI Manufacturer ID. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Vendor ID. Otherwise, this refers to the Vendor ID. For USB resources, this refers to the Vendor ID (VID)."
2996
  // STOP ATTRIBUTE
2997
  attribute: "Model Code"
2998
    "General Settings:Model Code"
2999
    uW readonly 00000000 3FFF00DF
3000
    // const: VI_ATTR_MODEL_CODE
3001
    "Returns the device model code assigned by the manufacturer. For VXI resources, this refers to the VXI Model Code. For PXI resources, if the subsystem PCI Vendor ID is nonzero, this refers to the subsystem Device ID. Otherwise, this refers to the Device ID. For USB resources, this refers to the Product ID (PID)."
3002
  // STOP ATTRIBUTE
3003
  attribute: "TermChar"
3004
    "Message Based Settings:Termination Character"
3005
    uB readwrite 80000000 3FFF0018
3006
    // const: VI_ATTR_TERMCHAR
3007
    "Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed)."
3008
  // STOP ATTRIBUTE
3009
  attribute: "TermChar En"
3010
    "Message Based Settings:Termination Character Enable"
3011
    bool readwrite 80000000 3FFF0038
3012
    // const: VI_ATTR_TERMCHAR_EN
3013
    "Specifies whether a read operation terminates when it receives the termination character. The default is FALSE."
3014
  // STOP ATTRIBUTE
3015
  attribute: "Suppress End En"
3016
    "Message Based Settings:Suppress End Enable"
3017
    bool readwrite 80000000 3FFF0036
3018
    // const: VI_ATTR_SUPPRESS_END_EN
3019
    "Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations.
3020

    
3021
For all session types that support this property, if this property is set to TRUE, read does not terminate due to an END condition. However, a read may still terminate successfully if the Message Based Settings:Termination Character Enable (TermChar En) property is set to TRUE. Otherwise, read does not terminate until it receives all of the requested data (or an error occurs). The default is FALSE (except for TCP/IP Socket sessions).
3022

    
3023
On Serial Instr sessions, if this property is set to FALSE, VISA performs the behavior described in the Serial Settings:End Mode for Reads (ASRL End In) property.
3024

    
3025
On USB Raw sessions, if this property is set to FALSE, VISA performs the behavior described in the USB Settings:End Mode for Reads (USB End In) property.
3026

    
3027
On TCP/IP Socket sessions, if this property is set to FALSE, if NI-VISA reads some data and then detects a pause in the arrival of data packets, it terminates the read operation. On TCP/IP Socket sessions, the default value for the property is TRUE in NI-VISA.
3028

    
3029
On VXI Instr sessions, if this property is set to FALSE, the END bit terminates read operations."
3030
  // STOP ATTRIBUTE
3031
  attribute: "IO Prot"
3032
    "Message Based Settings:IO Protocol"
3033
    uW enum {Normal=1, VXI/FDC=2, GPIB/HS488=3, "Serial-TCPIP-USB/488 Strings"=4, "USBTMC/Vendor-Specific"=5} readwrite 80000004 3FFF001C
3034
    // const: VI_ATTR_IO_PROT
3035
    "Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal."
3036
  // STOP ATTRIBUTE
3037
  attribute: "USB Serial Num"
3038
    "USB Settings:Serial Number"
3039
    string readonly 00000000 BFFF01A0
3040
    // const: VI_ATTR_USB_SERIAL_NUM
3041
    "Returns the USB serial number of this device."
3042
  // STOP ATTRIBUTE
3043
  attribute: "USB Intfc Num"
3044
    "USB Settings:USB Interface Number"
3045
    iW readonly 00000000 3FFF01A1
3046
    // const: VI_ATTR_USB_INTFC_NUM
3047
    "Returns the USB interface number used by the given session."
3048
  // STOP ATTRIBUTE
3049
  attribute: "USB Prot"
3050
    "USB Settings:USB Protocol"
3051
    iW readonly 00000000 3FFF01A7
3052
    // const: VI_ATTR_USB_PROTOCOL
3053
    "Returns the USB protocol used by the given session."
3054
  // STOP ATTRIBUTE
3055
  attribute: "USB Max Intr Size"
3056
    "USB Settings:Maximum Interrupt Size"
3057
    uW readwrite 80000000 3FFF01AF
3058
    // const: VI_ATTR_USB_MAX_INTR_SIZE
3059
    "Specifies the maximum size of data stored by any given USB interrupt. If a USB interrupt contains more data than this size, the data in excess of this size is lost. This property is read/write when the corresponding session is not enabled to receive USB interrupt events. When the session is enabled to receive USB interrupt events, this property is read only."
3060
  // STOP ATTRIBUTE
3061
  attribute: "USB Class"
3062
    "USB Settings:USB Class"
3063
    iW readonly 00000000 3FFF01A5
3064
    // const: VI_ATTR_USB_CLASS
3065
    "Returns the USB class used by the given session."
3066
  // STOP ATTRIBUTE
3067
  attribute: "USB Subclass"
3068
    "USB Settings:USB Subclass"
3069
    iW readonly 00000000 3FFF01A6
3070
    // const: VI_ATTR_USB_SUBCLASS
3071
    "Returns the USB subclass used by the given session."
3072
  // STOP ATTRIBUTE
3073
  attribute: "USB Alt Setting"
3074
    "USB Settings:Alternate Setting"
3075
    iW readwrite 00000000 3FFF01A8
3076
    // const: VI_ATTR_USB_ALT_SETTING
3077
    "Specifies the USB alternate setting used by this USB interface. The default is 0."
3078
  // STOP ATTRIBUTE
3079
  attribute: "USB Num Intfcs"
3080
    "USB Settings:Number of Interfaces"
3081
    iW readonly 00000000 3FFF01AA
3082
    // const: VI_ATTR_USB_NUM_INTFCS
3083
    "Returns the number of interfaces supported by this USB device."
3084
  // STOP ATTRIBUTE
3085
  attribute: "USB Num Pipes"
3086
    "USB Settings:Number of Pipes"
3087
    iW readonly 00000000 3FFF01AB
3088
    // const: VI_ATTR_USB_NUM_PIPES
3089
    "Returns the number of pipes supported by this USB interface."
3090
  // STOP ATTRIBUTE
3091
  attribute: "USB End In"
3092
    "USB Settings:End Mode for Reads"
3093
    uW enum {None=0, Short=4, "Short or Count"=5} readwrite 80000000 3FFF01A9
3094
    // const: VI_ATTR_USB_END_IN
3095
    "Specifies the method used to terminate read operations. Valid values include: (0) End None, (4) End Short, (5) End Short or Count. Use (0) End None to receive all requested data bytes regardless of any short packets. Use (4) End Short if the device sends a zero (short) packet when the last data packet is full. Use (5) End Short or Count if the device does not send zero packets. The default is (5) End Short or Count."
3096
  // STOP ATTRIBUTE
3097
  attribute: "USB Control Pipe"
3098
    "USB Settings:Control Pipe"
3099
    iW readwrite 80000000 3FFF01B0
3100
    // const: VI_ATTR_USB_CTRL_PIPE
3101
    "Specifies the endpoint address of the USB control pipe used by the given session. A value of 0 signifies the session will use the default control pipe. This endpoint is used in VISA USB Control In and VISA USB Control Out operations. Valid values are 0 to 15 (0x00 to 0x0f). Non-zero values may not be supported on all platforms. The default is 0."
3102
  // STOP ATTRIBUTE
3103
  attribute: "USB Out"
3104
    "USB Settings:Out Pipe"
3105
    iW readwrite 80000000 3FFF01A2
3106
    // const: VI_ATTR_USB_BULK_OUT_PIPE
3107
    "Specifies the endpoint number of the USB bulk-out or interrupt-out pipe used by the given session. An initial value of -1 signifies that this resource does not have any bulk-out or interrupt-out pipes. Other valid values are 1 to 15 (0x01 to 0x0f). VISA Write and related operations use this endpoint."
3108
  // STOP ATTRIBUTE
3109
  attribute: "USB Bulk-In"
3110
    "USB Settings:Bulk-In Pipe"
3111
    iW readwrite 80000000 3FFF01A3
3112
    // const: VI_ATTR_USB_BULK_IN_PIPE
3113
    "Specifies the endpoint number of the USB bulk-in pipe used by the given session. An initial value of -1 signifies that this resource does not have any bulk-in pipes. Other valid values are 129 to 143 (0x81 to 0x8f). VISA Read and related operations use this endpoint."
3114
  // STOP ATTRIBUTE
3115
  attribute: "USB Intr-In"
3116
    "USB Settings:Interrupt-In Pipe"
3117
    iW readwrite 80000000 3FFF01A4
3118
    // const: VI_ATTR_USB_INTR_IN_PIPE
3119
    "Specifies the endpoint number of the USB interrupt-in pipe used by the given session. An initial value of -1 signifies that this resource does not have any interrupt-in pipes. Other valid values are 129 to 143 (0x81 to 0x8f). VISA Enable Event uses this endpoint for the USB Interrupt Event."
3120
  // STOP ATTRIBUTE
3121
  attribute: "USB Out Stat"
3122
    "USB Settings:Out Pipe Status"
3123
    iW enum {Unknown=-1, Ready=0, Stalled=1} readwrite 80000000 3FFF01AC
3124
    // const: VI_ATTR_USB_BULK_OUT_STATUS
3125
    "Specifies whether the USB bulk-out or interrupt-out pipe used by the given session is stalled or ready."
3126
  // STOP ATTRIBUTE
3127
  attribute: "USB Bulk-In Stat"
3128
    "USB Settings:Bulk-In Pipe Status"
3129
    iW enum {Unknown=-1, Ready=0, Stalled=1} readwrite 80000000 3FFF01AD
3130
    // const: VI_ATTR_USB_BULK_IN_STATUS
3131
    "Specifies whether the USB bulk-in pipe used by the given session is stalled or ready."
3132
  // STOP ATTRIBUTE
3133
  attribute: "USB Intr-In Stat"
3134
    "USB Settings:Interrupt-In Pipe Status"
3135
    iW enum {Unknown=-1, Ready=0, Stalled=1} readwrite 80000000 3FFF01AE
3136
    // const: VI_ATTR_USB_INTR_IN_STATUS
3137
    "Specifies whether the USB interrupt-in pipe used by the given session is stalled or ready."
3138
  // STOP ATTRIBUTE
3139
  // STOP ATTRIBUTE LIST
3140

    
3141
  method: "VISA Read" noInvoke
3142
  method: "VISA Write" noInvoke
3143
  method: "VISA Read To File" noInvoke
3144
  method: "VISA Write From File" noInvoke
3145
  method: "VISA Clear" noInvoke
3146
  method: "VISA Read STB" noInvoke
3147
  method: "VISA Assert Trigger" noInvoke
3148
  method: "VISA USB Control Out" noInvoke
3149
  method: "VISA USB Control In" noInvoke
3150

    
3151
// STOP CLASS
3152

    
3153
class: "FireWire Instr"
3154
super: "I/O Session"
3155
sorted: no
3156
classString: "FIREWIRE?*::INSTR"
3157
  attribute: "Manf Name"
3158
    "General Settings:Manufacturer Name"
3159
    string readonly 00000000 BFFF0072
3160
    // const: VI_ATTR_MANF_NAME
3161
    "Returns the name of the manufacturer that created the device.
3162

    
3163
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
3164
  // STOP ATTRIBUTE
3165
  attribute: "Model Name"
3166
    "General Settings:Model Name"
3167
    string readonly 00000000 BFFF0077
3168
    // const: VI_ATTR_MODEL_NAME
3169
    "Returns the model name of the device. 
3170

    
3171
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
3172
  // STOP ATTRIBUTE
3173
  attribute: "Src Increment"
3174
    "Register Based Settings:Source Increment Count"
3175
    iL readwrite 80000000 3FFF0040
3176
    // const: VI_ATTR_SRC_INCREMENT
3177
    "Specifies the number of elements by which to increment the source address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move In X operations always read from the same element, essentially treating the source as a FIFO register."
3178
  // STOP ATTRIBUTE
3179
  attribute: "Dest Increment"
3180
    "Register Based Settings:Destination Increment Count"
3181
    iL readwrite 80000000 3FFF0041
3182
    // const: VI_ATTR_DEST_INCREMENT
3183
    "Specifies the number of elements by which to increment the destination address on block move operations. Valid values include 0 and 1. The default is 1. If this property is set to 0, VISA Move Out X operations always read from the same element, essentially treating the destination as a FIFO register."
3184
  // STOP ATTRIBUTE
3185
  attribute: "Win Base Addr"
3186
    "Register Based Settings:Window Base Address"
3187
    uL readonly 80000000 3FFF0098
3188
    // const: VI_ATTR_WIN_BASE_ADDR
3189
    "Returns the base interface address to which this window maps. If the Window Access property is Not Mapped, the value of this property is meaningless."
3190
  // STOP ATTRIBUTE
3191
  attribute: "Win Size"
3192
    "Register Based Settings:Window Size"
3193
    uL readonly 80000000 3FFF009A
3194
    // const: VI_ATTR_WIN_SIZE
3195
    "Returns the size of the region mapped to this window. If the Window Access property is Not Mapped, the value of this property is meaningless."
3196
  // STOP ATTRIBUTE
3197
  attribute: "Win Access"
3198
    "Register Based Settings:Window Access"
3199
    uW enum {"Not Mapped"=1, "Use Peek/Poke Operations"=2, "Can Dereference Pointer"=3, "Pointer value is byte-swapped"=4} readonly 80000000 3FFF00C3
3200
    // const: VI_ATTR_WIN_ACCESS
3201
    "Returns whether the current session has a mapped window, and if so, whether the window allows direct pointer dereferences."
3202
  // STOP ATTRIBUTE
3203
  attribute: "1394 Dest Upper"
3204
    "FireWire Settings:Destination Upper Offset"
3205
     uW readwrite 80000000 3FFF01F0
3206
    // const: VI_ATTR_FIREWIRE_DEST_UPPER_OFFSET
3207
    "Specifies the upper 16 bits of the 48-bit destination address for a FireWire device. The default is 0xFFFF."
3208
  // STOP ATTRIBUTE
3209
  attribute: "1394 Src Upper"
3210
    "FireWire Settings:Source Upper Offset"
3211
     uW readwrite 80000000 3FFF01F1
3212
    // const: VI_ATTR_FIREWIRE_SRC_UPPER_OFFSET
3213
    "Specifies the upper 16 bits of the 48-bit source address for a FireWire device. The default is 0xFFFF."
3214
  // STOP ATTRIBUTE
3215
  attribute: "1394 Win Upper"
3216
    "FireWire Settings:Window Upper Offset"
3217
     uW readwrite 80000000 3FFF01F2
3218
    // const: VI_ATTR_FIREWIRE_WIN_UPPER_OFFSET
3219
    "Specifies the upper 16 bits of the 48-bit address for a FireWire device when a window is mapped. The default is 0xFFFF."
3220
  // STOP ATTRIBUTE
3221
  attribute: "1394 Vendor"
3222
    "FireWire Settings:Vendor ID"
3223
     uL readonly 00000000 3FFF01F3
3224
    // const: VI_ATTR_FIREWIRE_VENDOR_ID
3225
    "Returns the vendor ID for a FireWire device."
3226
  // STOP ATTRIBUTE
3227
  attribute: "1394 Lower Chip"
3228
    "FireWire Settings:Lower Chip ID"
3229
     uL readonly 00000000 3FFF01F4
3230
    // const: VI_ATTR_FIREWIRE_LOWER_CHIP_ID
3231
    "Returns the lower chip ID for a FireWire device."
3232
  // STOP ATTRIBUTE
3233
  attribute: "1394 Upper Chip"
3234
    "FireWire Settings:Upper Chip ID"
3235
     uB readonly 00000000 3FFF01F5
3236
    // const: VI_ATTR_FIREWIRE_UPPER_CHIP_ID
3237
    "Specifies the upper chip ID for a FireWire device."
3238
  // STOP ATTRIBUTE
3239
  // STOP ATTRIBUTE LIST
3240

    
3241
  method: "VISA In 64" noInvoke
3242
  method: "VISA In 32" noInvoke
3243
  method: "VISA In 16" noInvoke
3244
  method: "VISA In 8" noInvoke
3245
  method: "VISA Out 64" noInvoke
3246
  method: "VISA Out 32" noInvoke
3247
  method: "VISA Map Address" noInvoke
3248
  method: "VISA Unmap Address" noInvoke
3249
  method: "VISA Peek 64" noInvoke
3250
  method: "VISA Peek 32" noInvoke
3251
  method: "VISA Peek 16" noInvoke
3252
  method: "VISA Peek 8" noInvoke
3253
  method: "VISA Poke 32" noInvoke
3254
  method: "VISA Poke 64" noInvoke
3255
  method: "VISA Move In 64" noInvoke
3256
  method: "VISA Move In 32" noInvoke
3257
  method: "VISA Move In 16" noInvoke
3258
  method: "VISA Move In 8" noInvoke
3259
  method: "VISA Move Out 32" noInvoke
3260
  method: "VISA Move Out 64" noInvoke
3261

    
3262
// STOP CLASS
3263
 
3264
 // Next are the Event classes
3265

    
3266
class: "Event Class"
3267
super: "VISA object"
3268
flags: 2
3269
sorted: no
3270
  attribute: "Impl Version"
3271
    "Version Information:Version of Implementation"
3272
    uL readonly 00000000 3FFF0003
3273
    // const: VI_ATTR_RSRC_IMPL_VERSION
3274
    "Returns the version of a given implementation. This value is defined by the individual manufacturer and increments with each new revision. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version."
3275
  // STOP ATTRIBUTE
3276
  attribute: "Spec Version"
3277
    "Version Information:Version of Specification"
3278
    uL readonly 00000000 3FFF0170
3279
    // const: VI_ATTR_RSRC_SPEC_VERSION
3280
    "Returns the value that uniquely identifies the version of the VISA specification to which the implementation complies. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version."
3281
  // STOP ATTRIBUTE
3282
  attribute: "Rsrc Manf Id"
3283
    "Version Information:Resource Manufacturer Identification"
3284
    uW readonly 00000000 3FFF0175
3285
    // const: VI_ATTR_RSRC_MANF_ID
3286
    "Returns the VXI manufacturer ID of the manufacturer that created the VISA implementation."
3287
  // STOP ATTRIBUTE
3288
  attribute: "Rsrc Manf Name"
3289
    "Version Information:Resource Manufacturer Name"
3290
    string readonly 00000000 BFFF0174
3291
    // const: VI_ATTR_RSRC_MANF_NAME
3292
    "Returns the name of the manufacturer that created the implementation. This is not related to the device manufacturer attributes.
3293

    
3294
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
3295
  // STOP ATTRIBUTE
3296
  // STOP ATTRIBUTE LIST
3297
// STOP CLASS
3298

    
3299
class: "Generic Event"
3300
super: "Event Class"
3301
flags: 4
3302
sorted: no
3303
  attribute: "Event Type"
3304
    "Event Information:Event Type"
3305
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3306
    // const: VI_ATTR_EVENT_TYPE
3307
    "Returns the unique logical identifier for the event type of the specified event."
3308
  // STOP ATTRIBUTE
3309
  attribute: "Recv Trig ID"
3310
    "Event Information:Received Trigger ID"
3311
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readonly 80000000 3FFF4012
3312
    // const: VI_ATTR_RECV_TRIG_ID
3313
    "Returns the triggering mechanism on which the specified trigger event was received. This is valid only for the Trigger event."
3314
  // STOP ATTRIBUTE
3315
  attribute: "Sig Stat ID"
3316
    "Event Information:Signal Processor Status ID"
3317
    uW readonly 80000000 3FFF4011
3318
    // const: VI_ATTR_SIGP_STATUS_ID
3319
    "Returns the 16-bit Status/ID value retrieved during the IACK cycle or from the Signal register. This is valid only for the VXI Signal event."
3320
  // STOP ATTRIBUTE
3321
  attribute: "Intr Stat ID"
3322
    "Event Information:Interrupt Status ID"
3323
    uL readonly 80000000 3FFF4023
3324
    // const: VI_ATTR_INTR_STATUS_ID
3325
    "Returns the 32-bit status/ID retrieved during the IACK cycle. This is valid only for the VXI/VME Interrupt event."
3326
  // STOP ATTRIBUTE
3327
  attribute: "Recv Intr Level"
3328
    "Event Information:Received Interrupt Level"
3329
    iW readonly 80000000 3FFF4041
3330
    // const: VI_ATTR_RECV_INTR_LEVEL
3331
    "Returns the VXI interrupt level on which the interrupt was received. This is valid only for the VXI/VME Interrupt event."
3332
  // STOP ATTRIBUTE
3333
  attribute: "Recv CIC State"
3334
    "Event Information:Received CIC State"
3335
    bool readonly 80000000 3FFF4193
3336
    // const: VI_ATTR_GPIB_RECV_CIC_STATE
3337
    "Returns the CIC status of either gained (TRUE) or lost (FALSE). This is valid only for the GPIB CIC event."
3338
  // STOP ATTRIBUTE
3339
  attribute: "Status"
3340
    "Event Information:Status"
3341
    iL readonly 80000000 3FFF4025
3342
    // const: VI_ATTR_STATUS
3343
    "Returns the VISA status code of the specified event."
3344
  // STOP ATTRIBUTE
3345
  attribute: "USB Recv Intr Size"
3346
    "Event Information:USB Received Interrupt Size"
3347
    uW readonly 80000000 3FFF41B0
3348
    // const: VI_ATTR_USB_RECV_INTR_SIZE
3349
    "Returns the number of bytes of USB interrupt data stored."
3350
  // STOP ATTRIBUTE
3351
  attribute: "PCI Recv Intr Seq"
3352
    "Event Information:PXI/PCI Received Interrupt Sequence"
3353
    iW readonly 80000000 3FFF4240
3354
    // const: VI_ATTR_PXI_RECV_INTR_SEQ
3355
    "Returns the index of the interrupt sequence that detected the interrupt condition."
3356
  // STOP ATTRIBUTE
3357
  attribute: "PCI Recv Intr Data"
3358
    "Event Information:PXI/PCI Received Interrupt Data"
3359
    uL readonly 80000000 3FFF4241
3360
    // const: VI_ATTR_PXI_RECV_INTR_DATA
3361
    "Returns the first PXI/PCI register read in the successful interrupt detection sequence."
3362
  // STOP ATTRIBUTE
3363
  // STOP ATTRIBUTE LIST
3364
// STOP CLASS
3365

    
3366
class: "Service Request Event"
3367
super: "Event Class"
3368
flags: 4
3369
sorted: no
3370
  attribute: "Event Type"
3371
    "Event Information:Event Type"
3372
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3373
    // const: VI_ATTR_EVENT_TYPE
3374
    "Returns the unique logical identifier for the event type of the specified event."
3375
  // STOP ATTRIBUTE
3376
  // STOP ATTRIBUTE LIST
3377
// STOP CLASS
3378

    
3379
class: "Trigger Event"
3380
super: "Event Class"
3381
flags: 4
3382
sorted: no
3383
  attribute: "Event Type"
3384
    "Event Information:Event Type"
3385
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3386
    // const: VI_ATTR_EVENT_TYPE
3387
    "Returns the unique logical identifier for the event type of the specified event."
3388
  // STOP ATTRIBUTE
3389
  attribute: "Recv Trig ID"
3390
    "Event Information:Received Trigger ID"
3391
    iW enum {Software=-1, TTL0=0, TTL1=1, TTL2=2, TTL3=3, TTL4=4, TTL5=5, TTL6=6, TTL7=7, ECL0=8, ECL1=9} readonly 80000000 3FFF4012
3392
    // const: VI_ATTR_RECV_TRIG_ID
3393
    "Returns the triggering mechanism on which the specified trigger event was received. This is valid only for the Trigger event."
3394
  // STOP ATTRIBUTE
3395
  // STOP ATTRIBUTE LIST
3396
// STOP CLASS
3397

    
3398
class: "VXI Signal Event"
3399
super: "Event Class"
3400
flags: 4
3401
sorted: no
3402
  attribute: "Event Type"
3403
    "Event Information:Event Type"
3404
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3405
    // const: VI_ATTR_EVENT_TYPE
3406
    "Returns the unique logical identifier for the event type of the specified event."
3407
  // STOP ATTRIBUTE
3408
  attribute: "Sig Stat ID"
3409
    "Event Information:Signal Processor Status ID"
3410
    uW readonly 80000000 3FFF4011
3411
    // const: VI_ATTR_SIGP_STATUS_ID
3412
    "Returns the 16-bit Status/ID value retrieved during the IACK cycle or from the Signal register. This is valid only for the VXI Signal Event."
3413
  // STOP ATTRIBUTE
3414
  // STOP ATTRIBUTE LIST
3415
// STOP CLASS
3416

    
3417
class: "VXI/VME Interrupt Event"
3418
super: "Event Class"
3419
flags: 4
3420
sorted: no
3421
  attribute: "Event Type"
3422
    "Event Information:Event Type"
3423
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3424
    // const: VI_ATTR_EVENT_TYPE
3425
    "Returns the unique logical identifier for the event type of the specified event."
3426
  // STOP ATTRIBUTE
3427
  attribute: "Intr Stat ID"
3428
    "Event Information:Interrupt Status ID"
3429
    uL readonly 80000000 3FFF4023
3430
    // const: VI_ATTR_INTR_STATUS_ID
3431
    "Returns the 32-bit status/ID retrieved during the IACK cycle. This is valid only for the VXI/VME Interrupt event."
3432
  // STOP ATTRIBUTE
3433
  attribute: "Recv Intr Level"
3434
    "Event Information:Received Interrupt Level"
3435
    iW readonly 80000000 3FFF4041
3436
    // const: VI_ATTR_RECV_INTR_LEVEL
3437
    "Returns the VXI interrupt level on which the interrupt was received. This is valid only for the VXI/VME Interrupt event."
3438
  // STOP ATTRIBUTE
3439
  // STOP ATTRIBUTE LIST
3440
// STOP CLASS
3441

    
3442
class: "PXI Interrupt Event"
3443
super: "Event Class"
3444
flags: 4
3445
sorted: no
3446
  attribute: "Event Type"
3447
    "Event Information:Event Type"
3448
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3449
    // const: VI_ATTR_EVENT_TYPE
3450
    "Returns the unique logical identifier for the event type of the specified event."
3451
  // STOP ATTRIBUTE
3452
  attribute: "PCI Recv Intr Seq"
3453
    "Event Information:PXI/PCI Received Interrupt Sequence"
3454
    iW readonly 80000000 3FFF4240
3455
    // const: VI_ATTR_PXI_RECV_INTR_SEQ
3456
    "Returns the index of the interrupt sequence that detected the interrupt condition."
3457
  // STOP ATTRIBUTE
3458
  attribute: "PCI Recv Intr Data"
3459
    "Event Information:PXI/PCI Received Interrupt Data"
3460
    uL readonly 80000000 3FFF4241
3461
    // const: VI_ATTR_PXI_RECV_INTR_DATA
3462
    "Returns the first PXI/PCI register read in the successful interrupt detection sequence."
3463
  // STOP ATTRIBUTE
3464
  // STOP ATTRIBUTE LIST
3465
// STOP CLASS
3466

    
3467
class: "USB Interrupt Event"
3468
super: "Event Class"
3469
flags: 4
3470
sorted: no
3471
  attribute: "Event Type"
3472
    "Event Information:Event Type"
3473
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3474
    // const: VI_ATTR_EVENT_TYPE
3475
    "Returns the unique logical identifier for the event type of the specified event."
3476
  // STOP ATTRIBUTE
3477
  attribute: "Status"
3478
    "Event Information:Status"
3479
    iL readonly 80000000 3FFF4025
3480
    // const: VI_ATTR_STATUS
3481
    "Returns the VISA status code of the specified event."
3482
  // STOP ATTRIBUTE
3483
  attribute: "USB Recv Intr Size"
3484
    "Event Information:USB Received Interrupt Size"
3485
    uW readonly 80000000 3FFF41B0
3486
    // const: VI_ATTR_USB_RECV_INTR_SIZE
3487
    "Returns the number of bytes of USB interrupt data stored."
3488
  // STOP ATTRIBUTE
3489
  // STOP ATTRIBUTE LIST
3490
// STOP CLASS
3491

    
3492
class: "Clear Event"
3493
super: "Event Class"
3494
flags: 4
3495
sorted: no
3496
  attribute: "Event Type"
3497
    "Event Information:Event Type"
3498
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3499
    // const: VI_ATTR_EVENT_TYPE
3500
    "Returns the unique logical identifier for the event type of the specified event."
3501
  // STOP ATTRIBUTE
3502
  // STOP ATTRIBUTE LIST
3503
// STOP CLASS
3504

    
3505
class: "GPIB CIC Event"
3506
super: "Event Class"
3507
flags: 4
3508
sorted: no
3509
  attribute: "Event Type"
3510
    "Event Information:Event Type"
3511
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3512
    // const: VI_ATTR_EVENT_TYPE
3513
    "Returns the unique logical identifier for the event type of the specified event."
3514
  // STOP ATTRIBUTE
3515
  attribute: "Recv CIC State"
3516
    "Event Information:Received CIC State"
3517
    bool readonly 80000000 3FFF4193
3518
    // const: VI_ATTR_GPIB_RECV_CIC_STATE
3519
    "Returns the CIC status of either gained (TRUE) or lost (FALSE). This is valid only for the GPIB CIC Event."
3520
  // STOP ATTRIBUTE
3521
  // STOP ATTRIBUTE LIST
3522
// STOP CLASS
3523

    
3524
class: "GPIB Talk Event"
3525
super: "Event Class"
3526
flags: 4
3527
sorted: no
3528
  attribute: "Event Type"
3529
    "Event Information:Event Type"
3530
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3531
    // const: VI_ATTR_EVENT_TYPE
3532
    "Returns the unique logical identifier for the event type of the specified event."
3533
  // STOP ATTRIBUTE
3534
  // STOP ATTRIBUTE LIST
3535
// STOP CLASS
3536

    
3537
class: "GPIB Listen Event"
3538
super: "Event Class"
3539
flags: 4
3540
sorted: no
3541
  attribute: "Event Type"
3542
    "Event Information:Event Type"
3543
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3544
    // const: VI_ATTR_EVENT_TYPE
3545
    "Returns the unique logical identifier for the event type of the specified event."
3546
  // STOP ATTRIBUTE
3547
  // STOP ATTRIBUTE LIST
3548
// STOP CLASS
3549

    
3550
class: "VXI/VME Sysfail Event"
3551
super: "Event Class"
3552
flags: 4
3553
sorted: no
3554
  attribute: "Event Type"
3555
    "Event Information:Event Type"
3556
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3557
    // const: VI_ATTR_EVENT_TYPE
3558
    "Returns the unique logical identifier for the event type of the specified event."
3559
  // STOP ATTRIBUTE
3560
  // STOP ATTRIBUTE LIST
3561
// STOP CLASS
3562

    
3563
class: "VXI/VME Sysreset Event"
3564
super: "Event Class"
3565
flags: 4
3566
sorted: no
3567
  attribute: "Event Type"
3568
    "Event Information:Event Type"
3569
    uL enum {"Service Request"=1073684491, Trigger=3221168138, Clear=1073684493, "VXI Signal"=1073684512, "VXI/VME Interrupt"=3221168161, "VXI/VME Sysfail"=1073684509, "VXI/VME Sysreset"=1073684510, "GPIB CIC"=1073684498, "GPIB Talk"=1073684499, "GPIB Listen"=1073684500, "PXI Interrupt"=1073684514, "USB Interrupt"=1073684535, "All Enabled"=1073709055} readonly 80000004 3FFF4010
3570
    // const: VI_ATTR_EVENT_TYPE
3571
    "Returns the unique logical identifier for the event type of the specified event."
3572
  // STOP ATTRIBUTE
3573
  // STOP ATTRIBUTE LIST
3574
// STOP CLASS
3575

    
3576
// Finally, there is the Resource Manager class
3577

    
3578
class: "Resource Manager"
3579
super: "VISA object"
3580
flags: 3
3581
sorted: no
3582
  attribute: "User Data"
3583
    "General Settings:User Data"
3584
    uL readwrite 80000000 3FFF0007
3585
    // const: VI_ATTR_USER_DATA
3586
    "Specifies a data value for the private use of an application. The VISA implementation stores this value in a per-session location, so that user data on other sessions does not affect the user data on this session. VISA does not use this property for any purpose."
3587
  // STOP ATTRIBUTE
3588
  attribute: "Impl Version"
3589
    "Version Information:Version of Implementation"
3590
    uL readonly 00000000 3FFF0003
3591
    // const: VI_ATTR_RSRC_IMPL_VERSION
3592
    "Returns the version of a given implementation. This value is defined by the individual manufacturer and increments with each new revision. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version."
3593
  // STOP ATTRIBUTE
3594
  attribute: "Spec Version"
3595
    "Version Information:Version of Specification"
3596
    uL readonly 00000000 3FFF0170
3597
    // const: VI_ATTR_RSRC_SPEC_VERSION
3598
    "Returns the value that uniquely identifies the version of the VISA specification to which the implementation complies. The format of the value has the upper 12 bits as the major number of the version, the next lower 12 bits as the minor number of the version, and the lowest 8 bits as the sub-minor number of the version."
3599
  // STOP ATTRIBUTE
3600
  attribute: "Rsrc Manf Id"
3601
    "Version Information:Resource Manufacturer Identification"
3602
    uW readonly 00000000 3FFF0175
3603
    // const: VI_ATTR_RSRC_MANF_ID
3604
    "Returns the VXI manufacturer ID of the manufacturer that created the VISA implementation."
3605
  // STOP ATTRIBUTE
3606
  attribute: "Rsrc Manf Name"
3607
    "Version Information:Resource Manufacturer Name"
3608
    string readonly 00000000 BFFF0174
3609
    // const: VI_ATTR_RSRC_MANF_NAME
3610
    "Returns the name of the manufacturer that created the implementation. This is not related to the device manufacturer attributes.
3611

    
3612
<B>Note:</B> Use the value of this property for display purposes only and not for programmatic decisions. The value can change between VISA implementations and/or revisions."
3613
  // STOP ATTRIBUTE
3614
  // STOP ATTRIBUTE LIST
3615
// STOP CLASS