Package uk.ac.gda.beamline.i20.scannable

Class Lakeshore340Scannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

uk.ac.gda.beamline.i20.scannable.Lakeshore340Scannable

All Implemented Interfaces:

Device, Scannable, Configurable, Findable, gda.observable.IObservable

public class Lakeshore340Scannable
extends ScannableBase

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
Lakeshore340Scannable()

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.
ILakeshore340	getController()
String	getControlmodeString()
double	getDeadtime()
String	getPvName()
String	getRangeString()
int	getTempSelect()
double	getTolerance()
int	getWaitTime()
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isMoving()
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Double	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setController(ILakeshore340 lakeshore340Controller)
void	setDeadtime(double deadtime)
void	setMoving(boolean isMoving)
void	setPvName(String pvName)
void	setTempSelect(int tempSelect)
void	setTolerance(double tolerance)
void	setup(String controlMode, String heaterRange, int waitTime, Double manualOutput, Double pValue, Double iValue, Double dValue, double tolerance)
void	setWaitTime(int waitTime)
void	stop()	Stop the current move/operation.
protected boolean	withinDeadband()

Methods inherited from class gda.device.scannable.ScannableBase

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

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, 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

Constructor Details

Lakeshore340Scannable

public Lakeshore340Scannable()

Method Details

getController

public ILakeshore340 getController()

setController

public void setController(ILakeshore340 lakeshore340Controller)

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 ConfigurableBase

Throws:

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

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 ScannableBase

Parameters:

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

Throws:

DeviceException

See Also:

• asynchronousMoveTo

rawGetPosition

public Double rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

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

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

getTempSelect

public int getTempSelect()

setTempSelect

public void setTempSelect(int tempSelect)

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Returns:

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

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

setup

public void setup(String controlMode,
 String heaterRange,
 int waitTime,
 Double manualOutput,
 Double pValue,
 Double iValue,
 Double dValue,
 double tolerance)
           throws DeviceException

Throws:

DeviceException

withinDeadband

protected boolean withinDeadband()
                          throws DeviceException

Throws:

DeviceException

getPvName

public String getPvName()

setPvName

public void setPvName(String pvName)

getTolerance

public double getTolerance()

setTolerance

public void setTolerance(double tolerance)

getDeadtime

public double getDeadtime()

setDeadtime

public void setDeadtime(double deadtime)

getWaitTime

public int getWaitTime()

setWaitTime

public void setWaitTime(int waitTime)

getRangeString

public String getRangeString()
                      throws IOException

Throws:

IOException

getControlmodeString

public String getControlmodeString()

setMoving

public void setMoving(boolean isMoving)

isMoving

public boolean isMoving()