|
OpenTAP 9.31
API Reference
|
Represents low-level IO primitives for a given SCPI instrument. IScpiIO3 is the full interface needed to specify a VISA connection. More...
Public Member Functions | |
| ScpiIOResult | EnableEvent (ScpiEvent eventType, ScpiEventMechanism mechanism) |
| Enables an event. | |
| ScpiIOResult | DisableEvent (ScpiEvent eventType, ScpiEventMechanism mechanism) |
| Disables an event. | |
| ScpiIOResult | WaitOnEvent (ScpiEvent eventType, int timeout, out ScpiEvent outEventType) |
| Waits on an event. | |
Public Member Functions inherited from OpenTap.IScpiIO2 | |
| ScpiIOResult | Open (string visaAddress, bool @lock) |
| Opens a connection to the instrument. More... | |
| ScpiIOResult | Close () |
| Close the connection to the instrument. More... | |
| void | OpenSRQ () |
| Open SRQ Callback handling. | |
| void | CloseSRQ () |
| Close SRQ Callback handling. | |
Public Member Functions inherited from OpenTap.IScpiIO | |
| ScpiIOResult | DeviceClear () |
| Clears the SCPI state, including any errors in the error queue. | |
| ScpiIOResult | ReadSTB (ref byte stb) |
| Reads the status byte of the instrument. More... | |
| ScpiIOResult | Read (ArraySegment< byte > buffer, int count, ref bool eoi, ref int read) |
| Reads a number of bytes from the instrument. More... | |
| ScpiIOResult | Write (ArraySegment< byte > buffer, int count, ref int written) |
| Writes a number of bytes to the instrument. More... | |
| ScpiIOResult | Lock (ScpiLockType lockType, string sharedKey=null) |
| Try to acquire a lock on the instrument. More... | |
| ScpiIOResult | Unlock () |
| Unlock an instrument. | |
Additional Inherited Members | |
Properties inherited from OpenTap.IScpiIO2 | |
| int | ID [get] |
| Resource ID attached to this instrument. | |
Properties inherited from OpenTap.IScpiIO | |
| bool | SendEnd [getset] |
| Indicates whether a Write(ArraySegment<byte>, int, ref int) should generate an end-of-message indicator when writing its last byte. | |
| int | IOTimeoutMS [getset] |
| Indicates the timeout in milliseconds for any of the IO operations. | |
| int | LockTimeoutMS [getset] |
| Indicates the timeout in milliseconds for acquiring a lock. | |
| byte | TerminationCharacter [getset] |
| Sets the termination character, if any. | |
| bool | UseTerminationCharacter [getset] |
| Controls whether the IO operations should use a termination character. | |
| string | ResourceClass [get] |
| Returns the resource class of the connected instrument. | |
Events inherited from OpenTap.IScpiIO2 | |
| ScpiIOSrqDelegate | SRQ |
| Callback from SRQ instrument events. | |
Represents low-level IO primitives for a given SCPI instrument. IScpiIO3 is the full interface needed to specify a VISA connection.
OpenTAP 9.31 API built Fri Oct 17 2025 07:12:36