Package gda.device.temperature

Class GdaLakeshore340

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.GdaLakeshore340

All Implemented Interfaces:

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

Direct Known Subclasses:

Lakeshore340With4Outputs

public class GdaLakeshore340
extends TemperatureBase
implements gda.observable.IObserver

4K temperature control supports Lakeshore 340 device using EpicsLakeshore340Controller.

Field Summary

Fields

Modifier and Type	Field	Description
protected ILakeshoreController	controller

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
GdaLakeshore340()	Constructor

Method Summary

Modifier and Type	Method	Description
void	begin()	perform the start/restart procedure of hardware
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()
void	end()	perform the shutdown procedure of the hardware perform the shutdown procedure of the temperature controller, i.e.
ILakeshoreController	getController()
double	getCurrentTemperature()	Get the current temperature
String	getEpicsLakeshore340ControllerName()
double	getRampRate()	gets the ramp rate
double	getTargetTemperature()	Get the target temperature
void	hold()	Stops running ramps or moving to temperature but holds the current temperature
boolean	isBusy()	Check if the Scannable is moving/operating.
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	reconfigure()	Re-initialisation of values and states.
void	runRamp()	Run the ramp sequence.
protected void	sendRamp(int which)	Program a temperature ramp into hardware, this does not initiate the program, it validates the target temperature and ramp rate.
void	sendStart()	Initiate the programmed temperature ramp in the hardware.
void	setController(ILakeshoreController controller)
void	setEpicsLakeshore340ControllerName(String controllerName)
protected void	setHWLowerTemp(double lowerTemp)
protected void	setHWUpperTemp(double upperTemp)
void	setRampRate(double rate)	sets the ramp rate
protected void	startNextRamp()
protected void	startTowardsTarget()	starts towards a single target temperature at current ramp rate Should send hardware commands to start heating or cooling towards a single targetTemp
void	temperatureUpdate()	Temperature GUI update.
String	toString()
void	update(Object theObserved, Object changeCode)

Methods inherited from class gda.device.temperature.TemperatureBase

addRamp, alarm, cancelAlarm, clearRamps, getAccuracy, getCurrentPositionArray, getDataDimensions, getFileSuffix, getLowerTemp, getPolltime, getProbeNames, getUpperTemp, isAtTargetTemperature, isRunning, readout, setAccuracy, setFileSuffix, setLowerTemp, setPollerUpdatePeriod, setPolltime, setProbe, setProbeNames, setRamps, setTargetTemperature, 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, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, 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

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

Field Details

controller

protected ILakeshoreController controller

Constructor Details

GdaLakeshore340

public GdaLakeshore340()

Constructor

Method Details

getController

public ILakeshoreController getController()

setController

public void setController(ILakeshoreController controller)

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

getCurrentTemperature

public double getCurrentTemperature()
                             throws DeviceException

Description copied from interface: Temperature

Get the current temperature

Specified by:

getCurrentTemperature in interface Temperature

Returns:

the current temperature

Throws:

DeviceException

getTargetTemperature

public double getTargetTemperature()
                            throws DeviceException

Get the target temperature

Specified by:

getTargetTemperature in interface Temperature

Overrides:

getTargetTemperature in class TemperatureBase

Returns:

the target temperature

Throws:

DeviceException

doStart

protected void doStart()
                throws DeviceException

Specified by:

doStart 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

Specified by:

hold in interface 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

sendRamp

protected void sendRamp(int which)
                 throws DeviceException

Program a temperature ramp into hardware, this does not initiate the program, it validates the target temperature and ramp rate.

Specified by:

sendRamp in class TemperatureBase

Throws:

DeviceException

See Also:

• TemperatureBase.sendRamp(int)

sendStart

public void sendStart()
               throws DeviceException

Initiate the programmed temperature ramp in the hardware.

Throws:

DeviceException

startNextRamp

protected void startNextRamp()
                      throws DeviceException

Specified by:

startNextRamp in class TemperatureBase

Throws:

DeviceException

doStop

protected void doStop()
               throws DeviceException

Specified by:

doStop in class TemperatureBase

Throws:

DeviceException

startTowardsTarget

protected void startTowardsTarget()
                           throws DeviceException

starts towards a single target temperature at current ramp rate Should send hardware commands to start heating or cooling towards a single targetTemp

Specified by:

startTowardsTarget in class TemperatureBase

Throws:

DeviceException

See Also:

• TemperatureBase.startTowardsTarget()

begin

public void begin()
           throws DeviceException

perform the start/restart procedure of hardware

Specified by:

begin in interface Temperature

Overrides:

begin in class TemperatureBase

Throws:

DeviceException

See Also:

• Temperature.end()

end

public void end()
         throws DeviceException

perform the shutdown procedure of the hardware perform the shutdown procedure of the temperature controller, i.e. properly running hardware warm-up or cool-down procedures perform the shutdown procedure of the controller

Specified by:

end in interface Temperature

Overrides:

end in class TemperatureBase

Throws:

DeviceException

See Also:

• TemperatureBase.end()

setRampRate

public void setRampRate(double rate)
                 throws DeviceException

sets the ramp rate

Specified by:

setRampRate in interface Temperature

Overrides:

setRampRate in class TemperatureBase

Parameters:

rate -

Throws:

DeviceException

getRampRate

public double getRampRate()
                   throws DeviceException

gets the ramp rate

Specified by:

getRampRate in interface Temperature

Overrides:

getRampRate in class TemperatureBase

Returns:

rate

Throws:

DeviceException

temperatureUpdate

public void temperatureUpdate()

Temperature GUI update.

Specified by:

temperatureUpdate in class TemperatureBase

getEpicsLakeshore340ControllerName

public String getEpicsLakeshore340ControllerName()

Returns:

EpicsLakeshore340ControllerName

setEpicsLakeshore340ControllerName

public void setEpicsLakeshore340ControllerName(String controllerName)

Parameters:

controllerName -

update

public void update(Object theObserved,
 Object changeCode)

Specified by:

update in interface gda.observable.IObserver

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object position)
                           throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.

Overrides:

rawAsynchronousMoveTo in class TemperatureBase

Parameters:

position - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class TemperatureBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from class: ScannableMotionBase

Check if the Scannable is moving/operating.. Calls onto rawIsBusy for historical reasons, although there is currently no need for this.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class TemperatureBase

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

See Also:

• Scannable.isBusy()

toString

public String toString()

Overrides:

toString in class ScannableBase

setHWLowerTemp

protected void setHWLowerTemp(double lowerTemp)
                       throws DeviceException

Specified by:

setHWLowerTemp in class TemperatureBase

Parameters:

lowerTemp -

Throws:

DeviceException

setHWUpperTemp

protected void setHWUpperTemp(double upperTemp)
                       throws DeviceException

Specified by:

setHWUpperTemp in class TemperatureBase

Parameters:

upperTemp -

Throws:

DeviceException