Package jisa.devices.interfaces

Interface TMeter

All Superinterfaces:

Instrument

All Known Subinterfaces:

MSTCouple, MSTMeter, TC.TMeter, TCouple

All Known Implementing Classes:

LS331.TMeter, LS336.TMeter, MercuryITC.TMeter, USBTC08

public interface TMeter
extends Instrument

Unified interface for thermometers

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 java.util.List<Instrument.Parameter<?>>	getConfigurationParameters(java.lang.Class<?> target)
static java.lang.String	getDescription()
double	getTemperature()	Returns the temperature being reported by the thermometer.
double	getTemperatureRange()	Returns the measurement range being used for temperature values.
void	setTemperatureRange(double range)	Sets the measurement range for temperature values.
default void	waitForStableTemperature(double temperature, double pctMargin, long duration)	Wait for the temperature to remain within a range of a given value for at least a specified amount of time.
default void	waitForStableTemperature(double pctMargin, long duration)	Wait for the temperature to remain within a percentage range of any value for at least a specified amount of time.
default void	waitForStableTemperatureMaxTime(double temperature, double pctMargin, long duration, long maxTime)	Wait for the temperature to remain within a range of a given value for at least a specified amount of time, with maximum time.
default void	waitForStableTemperatureMaxTime(double pctMargin, long duration, long maxTime)	Wait for the temperature to remain within a percentage range of any value for at least a specified amount of time, with max.

Methods inherited from interface jisa.devices.interfaces.Instrument

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

Method Detail

getDescription

static java.lang.String getDescription()

getTemperature

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

Returns the temperature being reported by the thermometer.

Returns:

Temperature, in Kelvin

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setTemperatureRange

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

Sets the measurement range for temperature values. The smallest available range containing the specified value will be selected if only discrete options are available.

Parameters:

range - The range to use, in Kelvin

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getTemperatureRange

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

Returns the measurement range being used for temperature values.

Returns:

The range being used, in Kelvin

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

waitForStableTemperature

default void waitForStableTemperature(double temperature,
                                      double pctMargin,
                                      long duration)
                               throws java.io.IOException,
                                      DeviceException,
                                      java.lang.InterruptedException

Wait for the temperature to remain within a range of a given value for at least a specified amount of time.

Parameters:

temperature - Temperature to be in range of

pctMargin - Percentage range to stay within

duration - Minimum time needed to be in range.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

java.lang.InterruptedException - Upon wait being interrupted

waitForStableTemperature

default void waitForStableTemperature(double pctMargin,
                                      long duration)
                               throws java.io.IOException,
                                      DeviceException,
                                      java.lang.InterruptedException

Wait for the temperature to remain within a percentage range of any value for at least a specified amount of time.

Parameters:

pctMargin - Percentage range to stay within

duration - Minimum time needed to be in range.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

java.lang.InterruptedException - Upon wait being interrupted

waitForStableTemperatureMaxTime

default void waitForStableTemperatureMaxTime(double pctMargin,
                                             long duration,
                                             long maxTime)
                                      throws java.io.IOException,
                                             DeviceException,
                                             java.lang.InterruptedException

Wait for the temperature to remain within a percentage range of any value for at least a specified amount of time, with max. time.

Parameters:

pctMargin - Percentage range to stay within

duration - Minimum time needed to be in range.

maxTime - Maximum time of stabilization

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

java.lang.InterruptedException - Upon wait being interrupted

waitForStableTemperatureMaxTime

default void waitForStableTemperatureMaxTime(double temperature,
                                             double pctMargin,
                                             long duration,
                                             long maxTime)
                                      throws java.io.IOException,
                                             DeviceException,
                                             java.lang.InterruptedException

Wait for the temperature to remain within a range of a given value for at least a specified amount of time, with maximum time.

Parameters:

temperature - Temperature to be in range of

pctMargin - Percentage range to stay within

duration - Minimum time needed to be in range.

maxTime - Maximum time of stabilization

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

java.lang.InterruptedException - Upon wait being interrupted

getConfigurationParameters

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

Specified by:

getConfigurationParameters in interface Instrument