Package jisa.devices.interfaces

Interface Instrument

All Known Subinterfaces:

Camera, DCPower, DPLockIn, EMController, FMeter, IMeter, ISource, IVMeter, IVSource, LevelMeter, LockIn, MCSMU, MSTCouple, MSTMeter, MSwitch, PID, PID.Input, PID.Loop, PID.Output, ProbeStation, SMU, SPA, Spectrometer, Switch, TC, TC.Heater, TC.Loop, TC.TMeter, TCouple, TMeter, VMeter, VPreAmp, VSource, XYTranslationStage, XYZTranslationStage

All Known Implementing Classes:

ADRelay, Agilent4155B, Agilent4155C, Agilent4156B, Agilent4156C, AgilentB1500A, AgilentCary6000i, AgilentE3644A, AgilentSPA, AgilentSPA.ASMU, AgilentSPA.AVMU, AgilentSPA.AVSU, AgilentSPA.GNDU, ArroyoTEC, Bruker70v, CryoCon22C, DDEDevice, DummyMCSMU, ET2408, FakeTC, ILM200, IPS120, ITC503, K1234, K2182, K2200, K236, K2400, K2450, K2600B, K6430, KeithleySCPI, LS331, LS331.Analogue, LS331.Heater, LS331.Loop, LS331.TMeter, LS336, LS336.Heater, LS336.Loop, LS336.TMeter, MCSMU.VirtualSMU, MercuryITC, MercuryITC.AuxOutput, MercuryITC.Heater, MercuryITC.Loop, MercuryITC.TMeter, ModbusRTUDevice, NativeDevice, Pegasus, PID.ZonedLoop, PipeDevice, SR560, SR830, TC.ZonedLoop, TestFET, TSX3510P, USBTC08, VISADevice, Webcam

public interface Instrument

Interface for defining the base functionality of all instruments.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Instrument.AutoQuantity<S>
static class	Instrument.OptionalQuantity<S>
static class	Instrument.Parameter<S>
static interface	Instrument.Setter<S>
static class	Instrument.TableQuantity

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection to the instrument.
Address	getAddress()	Returns any Address object used to connect to this instrument.
default java.util.List<Instrument.Parameter<?>>	getConfigurationParameters(java.lang.Class<?> target)
default java.util.List<Instrument.Parameter<?>>	getConfigurationParameters(kotlin.reflect.KClass<?> target)
java.lang.String	getIDN()	Returns an identifying String of the instrument.
default java.lang.Object	getLockObject()
java.lang.String	getName()	Returns the name of the instrument or channel.
default void	setTimeout(int msec)	Sets the timeout for read/write operations to this instrument (if applicable).

Method Detail

getIDN

java.lang.String getIDN()
                 throws java.io.IOException,
                        DeviceException

Returns an identifying String of the instrument.

Returns:

Identifying String

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getName

java.lang.String getName()

Returns the name of the instrument or channel.

Returns:

Name

close

void close()
    throws java.io.IOException,
           DeviceException

Closes the connection to the instrument.

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getAddress

Address getAddress()

Returns any Address object used to connect to this instrument.

Returns:

Address object, null if none

setTimeout

default void setTimeout(int msec)
                 throws java.io.IOException

Sets the timeout for read/write operations to this instrument (if applicable).

Parameters:

msec - Timeout, in milliseconds

Throws:

java.io.IOException - Upon communications error

getLockObject

default java.lang.Object getLockObject()

getConfigurationParameters

default java.util.List<Instrument.Parameter<?>> getConfigurationParameters(java.lang.Class<?> target)

getConfigurationParameters

default java.util.List<Instrument.Parameter<?>> getConfigurationParameters(kotlin.reflect.KClass<?> target)