OpenTap.ScpiIO Class Reference

Implements Visa SCPI IO. More...

Inheritance diagram for OpenTap.ScpiIO:

Public Member Functions
void	OpenSRQ ()
	Open SRQ Callback handling.
void	CloseSRQ ()
	Close SRQ Callback handling.
ScpiIOResult	Close ()
	Close the connection to the instrument. More...
ScpiIOResult	DeviceClear ()
	Clears the SCPI state, including any errors in the error queue.
ScpiIOResult	Lock (ScpiLockType lockType, string sharedKey=null)
	Try to acquire a lock on 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	ReadSTB (ref byte stb)
	Reads the status byte of the instrument. More...
ScpiIOResult	Unlock ()
	Unlock an instrument.
ScpiIOResult	Write (ArraySegment< byte > buffer, int count, ref int written)
	Writes a number of bytes to the instrument. More...
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...

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.

Detailed Description

Implements Visa SCPI IO.

Member Function Documentation

Close()

ScpiIOResult OpenTap.ScpiIO.Close ( )

inline

Close the connection to the instrument.

Returns

Visa Error code.

Implements OpenTap.IScpiIO2.

Lock()

ScpiIOResult OpenTap.ScpiIO.Lock ( ScpiLockType  lockType, string  sharedKey = null  )

inline

Try to acquire a lock on the instrument.

Parameters

lockType	Indicates which kind of lock should be acquired.
sharedKey	In case the type of lock is

Implements OpenTap.IScpiIO.

Read()

ScpiIOResult OpenTap.ScpiIO.Read ( ArraySegment< byte >  buffer, int  count, ref bool  eoi, ref int  read  )

inline

Reads a number of bytes from the instrument.

Parameters

buffer	The target buffer to read to.
count	The number of bytes to read.
eoi	This will indicate whether an EOI indicator was received.
read	The number of bytes that was actually read if succesful.

Implements OpenTap.IScpiIO.

ReadSTB()

ScpiIOResult OpenTap.ScpiIO.ReadSTB ( ref byte  stb )

inline

Reads the status byte of the instrument.

Parameters

stb	The current status byte.

Implements OpenTap.IScpiIO.

Write()

ScpiIOResult OpenTap.ScpiIO.Write ( ArraySegment< byte >  buffer, int  count, ref int  written  )

inline

Writes a number of bytes to the instrument.

The returned error code will indicate whether the EOI was sent.

Parameters

buffer	The buffer to write from.
count	The number of bytes to read.
written	The number of bytes that was actually written if succesful.

Implements OpenTap.IScpiIO.