Package gda.device.temperature

Class Marlow

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

All Implemented Interfaces:

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

public class Marlow
extends TemperatureBase
implements ReplyChecker

Class to control the Marlow SE50100 series controller. The Marlow expects even parity, 1 stop bit and 7 data bits with a baud rate selected between 300 invalid input: '&' 9600 README This particular class has been reinstated for CD12. It uses default values for serial as xml rewrite is in progress. Most new methods implemented in Eurotherm900 and Eurotherm2000 have been removed and there is no facility for writing to a file.

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

Method Summary

Modifier and Type	Method	Description
boolean	bufferContainsReply(StringBuffer buffer)	Implements methods from ReplyChecker class
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.
void	doStart()	This method needs re implementing, if necessary
void	doStop()	Sets the stop flag to true.
Object	getAttribute(String name)	Overrides the DeviceBase method to getAttribute.
double	getCurrentTemperature()	Gets the current temperature by asking the actual Marlow
int	getGid()
String	getSerialDeviceName()
double	getTargetTemperature()	Get the curent target temperature of the Marlow controller
int	getUid()
void	hold()	Hold at temperature
void	reconfigure()	Re-initialisation of values and states.
void	runRamp()	Run the ramp sequence.
protected void	sendRamp(int which)
void	setAttribute(String name, Object value)	Overrides the DeviceBase method to setAttributes.
void	setGid(int gid)
protected void	setHWLowerTemp(double lowerTemp)
protected void	setHWUpperTemp(double upperTemp)
void	setSerialDeviceName(String serialDeviceName)
void	setUid(int uid)
protected void	startNextRamp()
void	startTowardsTarget()	Starts a temperature change towards previously set target temperature.
void	temperatureUpdate()	Executes when poll timer fires
void	waitForTemp()	Is this method used now.

Methods inherited from class gda.device.temperature.TemperatureBase

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

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, externalToInternal, generateScannableLimitsReport, getAdditionalPositionValidators, 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, 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

getProtectionLevel, 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

Marlow

public Marlow()

Constructor

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)

Parameters:

serialDeviceName -

getSerialDeviceName

public String getSerialDeviceName()

Returns:

serialDeviceName

setUid

public void setUid(int uid)

Parameters:

uid -

getUid

public int getUid()

Returns:

uid

setGid

public void setGid(int gid)

Parameters:

gid -

getGid

public int getGid()

Returns:

gid

getCurrentTemperature

public double getCurrentTemperature()
                             throws DeviceException

Gets the current temperature by asking the actual Marlow

Specified by:

getCurrentTemperature in interface Temperature

Returns:

currentTemp

Throws:

DeviceException

getTargetTemperature

public double getTargetTemperature()
                            throws DeviceException

Get the curent target temperature of the Marlow controller

Specified by:

getTargetTemperature in interface Temperature

Overrides:

getTargetTemperature in class TemperatureBase

Returns:

the target temperature

Throws:

DeviceException

hold

public void hold()
          throws DeviceException

Hold at temperature

Specified by:

hold in interface Temperature

Throws:

DeviceException

temperatureUpdate

public void temperatureUpdate()

Executes when poll timer fires

Specified by:

temperatureUpdate in class TemperatureBase

bufferContainsReply

public boolean bufferContainsReply(StringBuffer buffer)

Implements methods from ReplyChecker class

Specified by:

bufferContainsReply in interface ReplyChecker

Parameters:

buffer - the reply from the Eurotherm

Returns:

true if reply is corretly formatted

getAttribute

public Object getAttribute(String name)
                    throws DeviceException

Overrides the DeviceBase method to getAttribute.

Specified by:

getAttribute in interface Device

Overrides:

getAttribute in class ScannableMotionBase

Parameters:

name - the name of the attribute to obtain

Returns:

the attribute

Throws:

DeviceException

See Also:

• DeviceBase.getAttribute(java.lang.String)

setAttribute

public void setAttribute(String name,
 Object value)
                  throws DeviceException

Overrides the DeviceBase method to setAttributes.

Specified by:

setAttribute in interface Device

Overrides:

setAttribute in class DeviceBase

Parameters:

name - the name of the attribute to obtain

value - the attribute to set

Throws:

DeviceException

doStart

public void doStart()
             throws DeviceException

This method needs re implementing, if necessary

Specified by:

doStart in class TemperatureBase

Throws:

DeviceException

doStop

public void doStop()
            throws DeviceException

Sets the stop flag to true. Should it set busy to false at this point?

Specified by:

doStop in class TemperatureBase

Throws:

DeviceException

sendRamp

protected void sendRamp(int which)
                 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

public void startTowardsTarget()
                        throws DeviceException

Starts a temperature change towards previously set target temperature. TargetTemp will have been set by the TemperatureBase method: setTargetTemperature(). This method sends the command to the hardware.

Specified by:

startTowardsTarget in class TemperatureBase

Throws:

DeviceException

waitForTemp

public void waitForTemp()
                 throws DeviceException

Is this method used now. If not - deprecate

Specified by:

waitForTemp in interface Temperature

Overrides:

waitForTemp 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

runRamp

public void runRamp()
             throws DeviceException

Description copied from class: TemperatureBase

Run the ramp sequence.

Specified by:

runRamp in class TemperatureBase

Throws:

DeviceException