Package gda.device.temperature

Class DummyTemperature

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

All Implemented Interfaces:

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

public class DummyTemperature
extends TemperatureBase

Dummy temperature class designed to simulate the temperature interface and TemperatureBase, without threads, for unit testing.

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
DummyTemperature()

Method Summary

Modifier and Type	Method	Description
protected void	doStart()
protected void	doStop()
double	getCurrentTemperature()	Get the current temperature
double	getHWLowerTemp()
double	getHWUpperTemp()
void	hold()	Stops running ramps or moving to temperature but holds the current temperature
boolean	isAtTargetTemperature()	Check the current temperature against the target temperature
void	runRamp()	Run the ramp sequence.
protected void	sendRamp(int ramp)
void	setHWLowerTemp(double lowLimit)
void	setHWUpperTemp(double upperLimit)
void	setTargetTemperature(double target)	Template method for starting a move towards a targetTemperature.
protected void	startNextRamp()
protected 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, configure, end, getAccuracy, getCurrentPositionArray, getDataDimensions, getFileSuffix, getLowerTemp, getPolltime, getProbeNames, getRampRate, getTargetTemperature, getUpperTemp, isBusy, isRunning, rawAsynchronousMoveTo, rawGetPosition, readout, setAccuracy, setFileSuffix, setLowerTemp, setPollerUpdatePeriod, setPolltime, setProbe, 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, close, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

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

Constructor Details

DummyTemperature

public DummyTemperature()

Method Details

getCurrentTemperature

public double getCurrentTemperature()
                             throws DeviceException

Description copied from interface: Temperature

Get the current temperature

Returns:

the current temperature

Throws:

DeviceException

setTargetTemperature

public void setTargetTemperature(double target)
                          throws DeviceException

Description copied from class: TemperatureBase

Template method for starting a move towards a targetTemperature. Subclasses must provide method startTowardsTarget which will send the necessary commands.

Specified by:

setTargetTemperature in interface Temperature

Overrides:

setTargetTemperature in class TemperatureBase

Parameters:

target - the target temperature

Throws:

DeviceException

isAtTargetTemperature

public boolean isAtTargetTemperature()
                              throws DeviceException

Description copied from interface: Temperature

Check the current temperature against the target temperature

Specified by:

isAtTargetTemperature in interface Temperature

Overrides:

isAtTargetTemperature in class TemperatureBase

Returns:

true if current temperature equals target temperature

Throws:

DeviceException

setHWLowerTemp

public void setHWLowerTemp(double lowLimit)
                    throws DeviceException

Specified by:

setHWLowerTemp in class TemperatureBase

Parameters:

lowLimit -

Throws:

DeviceException

setHWUpperTemp

public void setHWUpperTemp(double upperLimit)
                    throws DeviceException

Specified by:

setHWUpperTemp in class TemperatureBase

Parameters:

upperLimit -

Throws:

DeviceException

getHWUpperTemp

public double getHWUpperTemp()

Returns:

upper temperature

getHWLowerTemp

public double getHWLowerTemp()

Returns:

lower temperature

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

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

sendRamp

protected void sendRamp(int ramp)
                 throws DeviceException

Specified by:

sendRamp in class TemperatureBase

Throws:

DeviceException

startNextRamp

protected void startNextRamp()
                      throws DeviceException

Specified by:

startNextRamp in class TemperatureBase

Throws:

DeviceException

startTowardsTarget

protected 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

temperatureUpdate

public void temperatureUpdate()

Specified by:

temperatureUpdate in class TemperatureBase

runRamp

public void runRamp()
             throws DeviceException

Description copied from class: TemperatureBase

Run the ramp sequence.

Specified by:

runRamp in class TemperatureBase

Throws:

DeviceException