Package uk.ac.gda.beamline.b18.scannable

Class SimpleEpicsTemperatureController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.temperature.TemperatureBase

uk.ac.gda.beamline.b18.scannable.SimpleEpicsTemperatureController

All Implemented Interfaces:

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

public class SimpleEpicsTemperatureController
extends TemperatureBase

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

Method Summary

Modifier and Type	Method	Description
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	getCurrentTemperature()	Get the current temperature
String	getReadBackPVName()
String	getSetPointPVName()
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	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	runRamp()	Run the ramp sequence.
protected void	sendRamp(int ramp)
protected void	setHWLowerTemp(double lowerTemp)
protected void	setHWUpperTemp(double upperTemp)
void	setReadBackPVName(String readBackPVName)
void	setSetPointPVName(String setPointPVName)
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, end, getAccuracy, getCurrentPositionArray, getDataDimensions, getFileSuffix, getLowerTemp, getPolltime, getProbeNames, getRampRate, getTargetTemperature, getUpperTemp, isBusy, isRunning, rawGetPosition, readout, setAccuracy, setFileSuffix, setLowerTemp, setPollerUpdatePeriod, setPolltime, setProbe, setProbeNames, setRampRate, 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, 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

SimpleEpicsTemperatureController

public SimpleEpicsTemperatureController()

Method Details

getSetPointPVName

public String getSetPointPVName()

setSetPointPVName

public void setSetPointPVName(String setPointPVName)

getReadBackPVName

public String getReadBackPVName()

setReadBackPVName

public void setReadBackPVName(String readBackPVName)

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

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

getCurrentTemperature

public double getCurrentTemperature()
                             throws DeviceException

Description copied from interface: Temperature

Get the current temperature

Returns:

the current temperature

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

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

temperatureUpdate

public void temperatureUpdate()

Specified by:

temperatureUpdate in class TemperatureBase

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

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

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