OpenTap.IScpiIO2 Interface Reference

Represents low-level IO primitives for a given SCPI instrument. More...

Inheritance diagram for OpenTap.IScpiIO2:

Public Member Functions
ScpiIOResult	Open (string visaAddress, bool @lock)
	Opens a connection to the instrument.
ScpiIOResult	Close ()
	Close the connection to the instrument.
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.
ScpiIOResult	Read (ArraySegment< byte > buffer, int count, ref bool eoi, ref int read)
	Reads a number of bytes from the instrument.
ScpiIOResult	Write (ArraySegment< byte > buffer, int count, ref int written)
	Writes a number of bytes to the instrument.
ScpiIOResult	Lock (ScpiLockType lockType, string sharedKey=null)
	Try to acquire a lock on the instrument.
ScpiIOResult	Unlock ()
	Unlock an instrument.

Properties
int	ID [get]
	Resource ID attached to this instrument.
Properties inherited from OpenTap.IScpiIO
bool	SendEnd [get, set]
	Indicates whether a Write(ArraySegment<byte>, int, ref int) should generate an end-of-message indicator when writing its last byte.
int	IOTimeoutMS [get, set]
	Indicates the timeout in milliseconds for any of the IO operations.
int	LockTimeoutMS [get, set]
	Indicates the timeout in milliseconds for acquiring a lock.
byte	TerminationCharacter [get, set]
	Sets the termination character, if any.
bool	UseTerminationCharacter [get, set]
	Controls whether the IO operations should use a termination character.
string	ResourceClass [get]
	Returns the resource class of the connected instrument.

Events
ScpiIOSrqDelegate	SRQ
	Callback from SRQ instrument events.

Detailed Description

Represents low-level IO primitives for a given SCPI instrument.

Member Function Documentation

Close()

ScpiIOResult OpenTap.IScpiIO2.Close

(

)

Close the connection to the instrument.

Returns

Visa Error code.

Implemented in OpenTap.ScpiIO.

Open()

ScpiIOResult OpenTap.IScpiIO2.Open	(	string	visaAddress,
		bool @	lock )

Opens a connection to the instrument.

Parameters

visaAddress	Visa address of the instrument.
lock	if the instrument should be locked when the connection is established.

Returns

Visa error code.