| Instrument Control Toolbox |
  |
Properties Grouped by Category
This section contains brief descriptions of all toolbox properties. The properties are divided into these two groups:
Base Properties
Base properties apply to all supported instrument objects (GPIB, VISA-VXI, and so on). For example, the Timeout property is supported for all instrument objects. The base properties are organized into the following categories based on usage.
Write Properties
|
BytesToOutput
|
Indicate the number of bytes currently in the output buffer
|
OutputBufferSize
|
Specify the size of the output buffer in bytes
|
Timeout
|
Specify the waiting time to complete a read or write operation
|
TransferStatus
|
Indicate if an asynchronous read or write operation is in progress
|
ValuesSent
|
Indicate the total number of values written to the instrument
|
Read Properties
|
BytesAvailable
|
Indicate the number of bytes available in the input buffer
|
InputBufferSize
|
Specify the size of the input buffer in bytes
|
Timeout
|
Specify the waiting time to complete a read or write operation
|
TransferStatus
|
Indicate if an asynchronous read or write operation is in progress
|
ValuesReceived
|
Indicate the total number of values read from the instrument
|
Action Properties
|
BytesAvailable
Action
|
Specify the M-file action function to execute when a specified number of bytes are available in the input buffer, or a terminator is read
|
BytesAvailable
ActionCount
|
Specify the number of bytes that must be available in the input buffer to generate a bytes-available event
|
BytesAvailable
ActionMode
|
Specify if the bytes-available event is generated after a specified number of bytes are available in the input buffer, or after a terminator is read
|
ErrorAction
|
Specify the M-file action function to execute when an error event occurs
|
OutputEmpty
Action
|
Specify the M-file action function to execute when the output buffer is empty
|
TimerAction
|
Specify the M-file action function to execute when a predefined period of time passes
|
TimerPeriod
|
Specify the period of time between timer events
|
Recording Properties
|
RecordDetail
|
Specify the amount of information saved to a record file
|
RecordMode
|
Specify whether data and event information are saved to one record file or to multiple record files
|
RecordName
|
Specify the name of the record file
|
RecordStatus
|
Indicate if data and event information are saved to a record file
|
General Purpose Properties
|
ByteOrder
|
Specify the order in which the instrument stores bytes
|
Name
|
Specify a descriptive name for the instrument object
|
Status
|
Indicate if the instrument object is connected to the instrument
|
Tag
|
Specify a label to associate with a instrument object
|
Type
|
Indicate the object type
|
UserData
|
Specify data that you want to associate with a instrument object
|
| | Property Reference | | Object-Specific Properties | |