Package jisa.devices.interfaces

Interface PID

All Superinterfaces:

Instrument, MultiInstrument

All Known Subinterfaces:

TC

All Known Implementing Classes:

ArroyoTEC, CryoCon22C, ET2408, FakeTC, ITC503, LS331, LS336, MercuryITC

public interface PID
extends Instrument, MultiInstrument

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PID.Input	Represents an input channel for a PID controller
static interface	PID.Loop	Represents a single (independent) PID loop within a PID controller
static interface	PID.Output	Represents an output channel for a PID controller
static class	PID.Zone
static class	PID.ZonedLoop	Partial implementation of PID.Loop with pre-defined, software-based PID zoning

Nested classes/interfaces inherited from interface jisa.devices.interfaces.Instrument

Instrument.AutoQuantity<S>, Instrument.OptionalQuantity<S>, Instrument.Parameter<S>, Instrument.Setter<S>, Instrument.TableQuantity

Method Summary

Modifier and Type	Method	Description
default <I extends Instrument> java.util.List<I>	get(java.lang.Class<I> type)	Returns a list of all sub-instruments this instrument contains that can be considered to be of the given instrument type.
default PID.Input	getInput(int index)	Returns the input channel with a given index connected to this PID controller.
java.util.List<? extends PID.Input>	getInputs()	Returns a list of all input channels connected to this PID controller.
default PID.Loop	getLoop(int index)	Returns the control loop with a given index, provided by this PID controller.
java.util.List<? extends PID.Loop>	getLoops()	Returns a list of all control loops provided by this PID controller.
default PID.Output	getOutput(int index)	Returns the output channel with a given index connected to this PID controller.
java.util.List<? extends PID.Output>	getOutputs()	Returns a list of all output channels connected to this PID controller.
default <I extends Instrument> I	getSubInstrument(java.lang.Class<I> type, int index)
default java.util.List<java.lang.Class<? extends Instrument>>	getSubInstrumentTypes()	Returns a list of all the different classes of sub-instruments that this instrument contains.

Methods inherited from interface jisa.devices.interfaces.Instrument

close, getAddress, getConfigurationParameters, getConfigurationParameters, getIDN, getLockObject, getName, setTimeout

Methods inherited from interface jisa.devices.interfaces.MultiInstrument

contains, contains, get, getSubInstruments, getSubInstruments

Method Detail

getSubInstrumentTypes

default java.util.List<java.lang.Class<? extends Instrument>> getSubInstrumentTypes()

Description copied from interface: MultiInstrument

Returns a list of all the different classes of sub-instruments that this instrument contains.

Specified by:

getSubInstrumentTypes in interface MultiInstrument

Returns:

List of sub-instrument classes

get

default <I extends Instrument> java.util.List<I> get(java.lang.Class<I> type)

Description copied from interface: MultiInstrument

Returns a list of all sub-instruments this instrument contains that can be considered to be of the given instrument type.

Specified by:

get in interface MultiInstrument

Type Parameters:

I - Instrument class

Parameters:

type - The class object of sub-instrument to return

Returns:

List of sub-instruments matching the given class

getSubInstrument

default <I extends Instrument> I getSubInstrument(java.lang.Class<I> type,
                                                  int index)

Specified by:

getSubInstrument in interface MultiInstrument

getInputs

java.util.List<? extends PID.Input> getInputs()

Returns a list of all input channels connected to this PID controller.

Returns:

List of input channels

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getInput

default PID.Input getInput(int index)

Returns the input channel with a given index connected to this PID controller.

Parameters:

index - Input index

Returns:

Input channel with specified index

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getOutputs

java.util.List<? extends PID.Output> getOutputs()

Returns a list of all output channels connected to this PID controller.

Returns:

List of output channels

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getOutput

default PID.Output getOutput(int index)

Returns the output channel with a given index connected to this PID controller.

Parameters:

index - Output index

Returns:

Output channel with specified index

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getLoops

java.util.List<? extends PID.Loop> getLoops()

Returns a list of all control loops provided by this PID controller.

Returns:

List of control loops

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getLoop

default PID.Loop getLoop(int index)

Returns the control loop with a given index, provided by this PID controller.

Parameters:

index - Control loop index

Returns:

PID control loop with specified index

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error