Package gda.device

Interface Temperature

All Superinterfaces:

Configurable, Device, Findable, gda.observable.IObservable, Scannable

All Known Implementing Classes:

DummyTemp, DummyTemperature, Eurotherm2K, GdaLakeshore340, Lakeshore340With4Outputs, Lauda, LinkamCI, LinkamT95, Marlow, OxfordCryostream700, SimpleEpicsTemperatureController, TemperatureBase

public interface Temperature
extends Scannable

An interface to be implemented by distributed Temperature controllers

Field Summary

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Method Summary

Modifier and Type	Method	Description
void	addRamp(TemperatureRamp ramp)	Adds a new ramp
void	begin()	perform the start/restart up procedure of the controller
void	clearRamps()	Clears all specified ramps
void	end()	perform the shutdown procedure of the controller
double	getCurrentTemperature()	Get the current temperature
double	getLowerTemp()	Get the lower operating temperature limit
List<String>	getProbeNames()	Get probe names
double	getRampRate()	gets the ramp rate
double	getTargetTemperature()	Get the target temperature
double	getUpperTemp()	Get the upper operating temperature limit
void	hold()	Stops running ramps or moving to temperature but holds the current temperature
boolean	isAtTargetTemperature()	Check the current temperature against the target temperature
boolean	isRunning()	Gets the running state of the controller
void	setLowerTemp(double lowLimit)	Set to the lower operating temperature
void	setProbe(String probeName)	Select probe
void	setRampRate(double rate)	sets the ramp rate
void	setRamps(List<TemperatureRamp> ramps)	Sets a list of ramps
void	setTargetTemperature(double target)	Set the target or end temperature
void	setUpperTemp(double upperLimit)	Set the upper operating temperature
void	start()	Start running the ramps
void	stop()	Stops running ramps or moving to temperature (allows the device to do whatever it does while not running programs), or in some case just hold the temperature position
void	waitForTemp()	Suspend the current thread and wait for the controller to reach its target temperature

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString, waitWhileBusy

Method Details

getCurrentTemperature

double getCurrentTemperature()
                      throws DeviceException

Get the current temperature

Returns:

the current temperature

Throws:

DeviceException

setTargetTemperature

void setTargetTemperature(double target)
                   throws DeviceException

Set the target or end temperature

Parameters:

target - the target temperature

Throws:

DeviceException

getTargetTemperature

double getTargetTemperature()
                     throws DeviceException

Get the target temperature

Returns:

the target temperature

Throws:

DeviceException

isAtTargetTemperature

boolean isAtTargetTemperature()
                       throws DeviceException

Check the current temperature against the target temperature

Returns:

true if current temperature equals target temperature

Throws:

DeviceException

setLowerTemp

void setLowerTemp(double lowLimit)
           throws DeviceException

Set to the lower operating temperature

Parameters:

lowLimit - the lower temperature limit in degrees C

Throws:

DeviceException

setUpperTemp

void setUpperTemp(double upperLimit)
           throws DeviceException

Set the upper operating temperature

Parameters:

upperLimit - the upper temperature limit in degrees C

Throws:

DeviceException

getUpperTemp

double getUpperTemp()
             throws DeviceException

Get the upper operating temperature limit

Returns:

the upper temperature limit in degrees C

Throws:

DeviceException

getLowerTemp

double getLowerTemp()
             throws DeviceException

Get the lower operating temperature limit

Returns:

the lower temperature limit in degrees C

Throws:

DeviceException

getProbeNames

List<String> getProbeNames()
                    throws DeviceException

Get probe names

Returns:

an array of probe names

Throws:

DeviceException

setProbe

void setProbe(String probeName)
       throws DeviceException

Select probe

Parameters:

probeName - the probe to use

Throws:

DeviceException

waitForTemp

void waitForTemp()
          throws DeviceException

Suspend the current thread and wait for the controller to reach its target temperature

Throws:

DeviceException

clearRamps

void clearRamps()
         throws DeviceException

Clears all specified ramps

Throws:

DeviceException

addRamp

void addRamp(TemperatureRamp ramp)
      throws DeviceException

Adds a new ramp

Parameters:

ramp - the new TemperatureRamp to add

Throws:

DeviceException

start

void start()
    throws DeviceException

Start running the ramps

Throws:

DeviceException

stop

void stop()
   throws DeviceException

Stops running ramps or moving to temperature (allows the device to do whatever it does while not running programs), or in some case just hold the temperature position

Specified by:

stop in interface Scannable

Throws:

DeviceException

begin

void begin()
    throws DeviceException

perform the start/restart up procedure of the controller

Throws:

DeviceException

end

void end()
  throws DeviceException

perform the shutdown procedure of the controller

Throws:

DeviceException

setRampRate

void setRampRate(double rate)
          throws DeviceException

sets the ramp rate

Parameters:

rate -

Throws:

DeviceException

getRampRate

double getRampRate()
            throws DeviceException

gets the ramp rate

Returns:

rate

Throws:

DeviceException

hold

void hold()
   throws DeviceException

Stops running ramps or moving to temperature but holds the current temperature

Throws:

DeviceException

setRamps

void setRamps(List<TemperatureRamp> ramps)
       throws DeviceException

Sets a list of ramps

Parameters:

ramps - an ArrayList of TemperatureRamps

Throws:

DeviceException

isRunning

boolean isRunning()
           throws DeviceException

Gets the running state of the controller

Returns:

true if controller is running a program or moving to a target false otherwise

Throws:

DeviceException