Package gda.device.temperature

Class Lauda

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.temperature.TemperatureBase

gda.device.temperature.Lauda

All Implemented Interfaces:

INeXusInfoWriteable, Device, Scannable, ScannableMotion, Temperature, Configurable, Findable, gda.observable.IObservable, AlarmListener

public class Lauda
extends TemperatureBase

Class to control the Lauda Compact Low-Temperature Thermostat.

Field Summary

Fields inherited from class gda.device.temperature.TemperatureBase

bufferedData, busy, count, currentRamp, currentTemp, dataFileWriter, dataWriter, fileSuffix, LONG_POLL_TIME, longPollTime, lowerTemp, POLL_TIME, pollTime, probeNameList, rampList, setPoint, SHORT_POLL_TIME, targetTemp, timeSinceStart, upperTemp

Fields inherited from class gda.device.scannable.ScannableMotionBase

numberTries, tolerance

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Fields inherited from interface gda.device.ScannableMotion

FIRSTINPUTLIMITS

Constructor Summary

Constructors

Constructor	Description
Lauda()	Constructs a Lauda bath, starting a new thread to monitor the current temperature.

Method Summary

Modifier and Type	Method	Description
void	close()	Close and unconfigure the device.
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
protected void	doStart()
protected void	doStop()
double	getBathTemp()	Read the temperature of the controlling device either internal bath external probe1 or external probe2.
double	getCurrentTemperature()	Read the temperature of the Lauda bath.
double	getExtProbe1()	Read the temperature of the external probe 1.
double	getExtProbe2()	Read the temperature of the external probe 2.
String	getSerialDeviceName()	Get the name of the serial communication port on the host computer.
double	getSetPoint()	Get the current setpoint temperature.
String	getStatusSignal()	Get the status signal
double	getTn()	Get the control parameter Tn for the controller.
double	getTv()	Get the control parameter Tv for the controller.
double	getXp()	Get the control parameter Xp for the controller.
void	hold()	Stops running ramps or moving to temperature but holds the current temperature
void	reconfigure()	Re-initialisation of values and states.
void	runRamp()	Run the ramp sequence.
protected void	sendRamp(int which)	Program a timed temperature ramp into the Lauda bath.
void	sendStart()	Initiate the programmed temperature ramp in the Lauda bath.
void	setExtProbe1()	Switch control variable to source external Pt 100 T1
void	setExtProbe2()	Switch control variable to source external Pt 100 T2
void	setHWLowerTemp(double lowLimit)	Set the switching point for undertemperature (usually set to the lower operating temperature of the Lauda bath thermostat, it must be in the range -35C and 200C.
void	setHWUpperTemp(double upperLimit)	Set the upper operating temperature of the Lauda bath, it must be in the range -35C and 200C.
void	setIntProbe()	Switch control variable to source Ti (probe in the bath); control according to bath temperature (Default setting at power on)
void	setProbe(String name)	Switch control variable to source external Pt 100 T1
void	setSerialDeviceName(String serialDeviceName)	Set the name of the serial communication port on the host computer.
void	setTargetTemperature(double temp)	Set the temperature of the Lauda bath in the range -20C to 150C.
void	setTnControl(double time)	Set the control paramter Tn for the controller
void	setTvControl(double time)	Set the control paramter Tv for the controller
void	setXpControl(double temp)	Set the proportional band control paramter Xp for the controller
protected void	startNextRamp()
void	startTowardsTarget()	Should send hardware commands to start heating or cooling towards a single targetTemp
void	temperatureUpdate()

Methods inherited from class gda.device.temperature.TemperatureBase

addRamp, alarm, begin, cancelAlarm, clearRamps, end, getAccuracy, getCurrentPositionArray, getDataDimensions, getFileSuffix, getLowerTemp, getPolltime, getProbeNames, getRampRate, getTargetTemperature, getUpperTemp, isAtTargetTemperature, isBusy, isRunning, rawAsynchronousMoveTo, rawGetPosition, readout, setAccuracy, setFileSuffix, setLowerTemp, setPollerUpdatePeriod, setPolltime, setProbeNames, setRampRate, setRamps, setUpperTemp, start, startHoldTimer, startPoller, stop, stopPoller, waitForTemp

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, externalToInternal, generateScannableLimitsReport, getAdditionalPositionValidators, getAttribute, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, internalToExternal, isAt, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, toFormattedString, writeNeXusInformation, writeNeXusInformationLimits

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

isConfigured, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured

Methods inherited from interface gda.device.Device

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, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString, waitWhileBusy

Constructor Details

Lauda

public Lauda()

Constructs a Lauda bath, starting a new thread to monitor the current temperature.

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class TemperatureBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

reconfigure

public void reconfigure()
                 throws FactoryException

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ConfigurableBase

Throws:

FactoryException

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Overrides:

close in class DeviceBase

Throws:

DeviceException

setSerialDeviceName

public void setSerialDeviceName(String serialDeviceName)

Set the name of the serial communication port on the host computer.

Parameters:

serialDeviceName - the name of the serial port

getSerialDeviceName

public String getSerialDeviceName()

Get the name of the serial communication port on the host computer.

Returns:

the name of the serial port

doStart

protected void doStart()
                throws DeviceException

Specified by:

doStart in class TemperatureBase

Throws:

DeviceException

doStop

protected void doStop()
               throws DeviceException

Specified by:

doStop in class TemperatureBase

Throws:

DeviceException

getCurrentTemperature

public double getCurrentTemperature()
                             throws DeviceException,
NumberFormatException

Read the temperature of the Lauda bath.

Returns:

the Lauda water bath temperature

Throws:

DeviceException

NumberFormatException

setTargetTemperature

public void setTargetTemperature(double temp)
                          throws DeviceException

Set the temperature of the Lauda bath in the range -20C to 150C.

Specified by:

setTargetTemperature in interface Temperature

Overrides:

setTargetTemperature in class TemperatureBase

Parameters:

temp - required temparature of the Lauda water bath.

Throws:

DeviceException

getSetPoint

public double getSetPoint()
                   throws DeviceException

Get the current setpoint temperature.

Returns:

the setpoint temperature

Throws:

DeviceException

setHWLowerTemp

public void setHWLowerTemp(double lowLimit)
                    throws DeviceException

Set the switching point for undertemperature (usually set to the lower operating temperature of the Lauda bath thermostat, it must be in the range -35C and 200C.

Specified by:

setHWLowerTemp in class TemperatureBase

Parameters:

lowLimit - the lower temperature limit in degrees C

Throws:

DeviceException

setHWUpperTemp

public void setHWUpperTemp(double upperLimit)
                    throws DeviceException

Set the upper operating temperature of the Lauda bath, it must be in the range -35C and 200C.

Specified by:

setHWUpperTemp in class TemperatureBase

Parameters:

upperLimit - the upper temperature limit in degrees C

Throws:

DeviceException

setProbe

public void setProbe(String name)
              throws DeviceException

Switch control variable to source external Pt 100 T1

Specified by:

setProbe in interface Temperature

Overrides:

setProbe in class TemperatureBase

Parameters:

name - the probe name

Throws:

DeviceException

sendRamp

protected void sendRamp(int which)
                 throws DeviceException

Program a timed temperature ramp into the Lauda bath. This does not initiate the program. Unrealistically short times will generate an error and the parameters will not be set.

Specified by:

sendRamp in class TemperatureBase

Parameters:

which - is the required ramp to load

Throws:

DeviceException

sendStart

public void sendStart()
               throws DeviceException

Initiate the programmed temperature ramp in the Lauda bath.

Throws:

DeviceException

setExtProbe1

public void setExtProbe1()
                  throws DeviceException

Switch control variable to source external Pt 100 T1

Throws:

DeviceException

setExtProbe2

public void setExtProbe2()
                  throws DeviceException

Switch control variable to source external Pt 100 T2

Throws:

DeviceException

setIntProbe

public void setIntProbe()
                 throws DeviceException

Switch control variable to source Ti (probe in the bath); control according to bath temperature (Default setting at power on)

Throws:

DeviceException

getBathTemp

public double getBathTemp()
                   throws DeviceException,
NumberFormatException

Read the temperature of the controlling device either internal bath external probe1 or external probe2.

Returns:

the control temperature

Throws:

DeviceException

NumberFormatException

getExtProbe1

public double getExtProbe1()
                    throws DeviceException

Read the temperature of the external probe 1.

Returns:

the external probe 1 temperature

Throws:

DeviceException

getExtProbe2

public double getExtProbe2()
                    throws DeviceException

Read the temperature of the external probe 2.

Returns:

the external probe 2 temperature

Throws:

DeviceException

setXpControl

public void setXpControl(double temp)
                  throws DeviceException

Set the proportional band control paramter Xp for the controller

Parameters:

temp - the Xp (degrees)

Throws:

DeviceException

setTnControl

public void setTnControl(double time)
                  throws DeviceException

Set the control paramter Tn for the controller

Parameters:

time - Control parameter Tn (secs)

Throws:

DeviceException

setTvControl

public void setTvControl(double time)
                  throws DeviceException

Set the control paramter Tv for the controller

Parameters:

time - the Tv (secs)

Throws:

DeviceException

getXp

public double getXp()
             throws DeviceException

Get the control parameter Xp for the controller.

Returns:

the control parameter Xp

Throws:

DeviceException

getTn

public double getTn()
             throws DeviceException

Get the control parameter Tn for the controller.

Returns:

the control parameter Tn

Throws:

DeviceException

getTv

public double getTv()
             throws DeviceException

Get the control parameter Tv for the controller.

Returns:

the control parameter Tv

Throws:

DeviceException

getStatusSignal

public String getStatusSignal()
                       throws DeviceException

Get the status signal

Returns:

the status

Throws:

DeviceException

startNextRamp

protected void startNextRamp()
                      throws DeviceException

Specified by:

startNextRamp in class TemperatureBase

Throws:

DeviceException

temperatureUpdate

public void temperatureUpdate()

Specified by:

temperatureUpdate in class TemperatureBase

startTowardsTarget

public void startTowardsTarget()
                        throws DeviceException

Description copied from class: TemperatureBase

Should send hardware commands to start heating or cooling towards a single targetTemp

Specified by:

startTowardsTarget in class TemperatureBase

Throws:

DeviceException

hold

public void hold()
          throws DeviceException

Description copied from interface: Temperature

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

Throws:

DeviceException

runRamp

public void runRamp()
             throws DeviceException

Description copied from class: TemperatureBase

Run the ramp sequence.

Specified by:

runRamp in class TemperatureBase

Throws:

DeviceException