Package jisa.devices.interfaces

Interface PID.Input

All Superinterfaces:

Instrument

All Known Subinterfaces:

TC.TMeter

All Known Implementing Classes:

LS331.TMeter, LS336.TMeter, MercuryITC.TMeter

Enclosing interface:

PID

public static interface PID.Input
extends Instrument

Represents an input 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.
java.lang.String	getName()	Returns the name of this input.
double	getRange()	Returns the measurement range currently being used by this input.
default java.lang.String	getSensorName()
java.lang.String	getUnits()	Returns the units (if any) of the quantity this input is measuring.
double	getValue()	Returns the value currently being sensed by this input.
java.lang.String	getValueName()	Returns the name of the quantity this input is measuring.
void	setRange(double range)	Sets the measurement range to be used by this input.

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 currently being sensed by this input.

Returns:

Sensed value

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getRange

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

Returns the measurement range currently being used by this input.

Returns:

Measurement range

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setRange

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

Sets the measurement range to be used by this input. Specify the largest (absolute) value you wish to measure, and it will select the smallest range that contains it.

Parameters:

range - Maximum (absolute) value to be measured

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getName

java.lang.String getName()

Returns the name of this input.

Specified by:

getName in interface Instrument

Returns:

Input name

getSensorName

default java.lang.String getSensorName()

getValueName

java.lang.String getValueName()

Returns the name of the quantity this input is measuring.

Returns:

Input quantity name

getUnits

java.lang.String getUnits()

Returns the units (if any) of the quantity this input is measuring.

Returns:

Input 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