Package jisa.devices.interfaces

Interface PID.Output

All Superinterfaces:

Instrument

All Known Subinterfaces:

TC.Heater

All Known Implementing Classes:

LS331.Analogue, LS331.Heater, LS336.Heater, MercuryITC.AuxOutput, MercuryITC.Heater

Enclosing interface:

PID

public static interface PID.Output
extends Instrument

Represents an output channel for a PID controller

Nested Class Summary

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 void	close()	Closes the connection to the instrument.
double	getLimit()	Returns the limit/range currently being applied to the output value.
java.lang.String	getName()	Returns the name of the output.
java.lang.String	getUnits()	Returns the units (if any) of the output quantity.
double	getValue()	Returns the value this output is currently outputting.
java.lang.String	getValueName()	Returns the name of the output quantity.
void	setLimit(double range)	Sets the limit/range to apply to the output value.

Methods inherited from interface jisa.devices.interfaces.Instrument

getAddress, getConfigurationParameters, getConfigurationParameters, getIDN, getLockObject, setTimeout

Method Detail

getValue

double getValue()
         throws java.io.IOException,
                DeviceException

Returns the value this output is currently outputting.

Returns:

Value being output

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getLimit

double getLimit()
         throws java.io.IOException,
                DeviceException

Returns the limit/range currently being applied to the output value.

Returns:

Output limit

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setLimit

void setLimit(double range)
       throws java.io.IOException,
              DeviceException

Sets the limit/range to apply to the output value.

Parameters:

range - Output limit/range

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getName

java.lang.String getName()

Returns the name of the output.

Specified by:

getName in interface Instrument

Returns:

Output name

getValueName

java.lang.String getValueName()

Returns the name of the output quantity.

Returns:

Output quantity name

getUnits

java.lang.String getUnits()

Returns the units (if any) of the output quantity.

Returns:

Output quantity units

close

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

Description copied from interface: Instrument

Closes the connection to the instrument.

Specified by:

close in interface Instrument

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device