Package uk.ac.diamond.daq.devices.keithley

Class AbstractKeithley2600Series

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

uk.ac.diamond.daq.devices.keithley.AbstractKeithley2600Series

All Implemented Interfaces:

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

Direct Known Subclasses:

DummyKeithley2600Series, Keithley2600Series

public abstract class AbstractKeithley2600Series
extends ScannableBase

Abstract base class for Keithley 2600 Series source meter.

Since:

GDA 9.11

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractKeithley2600Series.ResistanceMode
protected static enum	AbstractKeithley2600Series.SourceMode
protected static enum	AbstractKeithley2600Series.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CURRENT_LEVEL_SETPOINT
protected final HashMap<String,Object>	dataMapToWrite
protected HashMap<String,DetectorDataEntry<?>>	detectorDataEntryMap
protected static final String	DWELL_TIME
protected static final String	INTEGRATION_TIME
protected boolean	isFirstPoint	Flag indicating whether we are on the first point
protected AbstractKeithley2600Series.Status	limitStatus	The status showing if the voltage or current limits are reached
protected static final String	MEAN_CURRENT
protected static final String	MEAN_VOLTAGE
protected static final String	NUMBER_OF_READINGS
protected static final String	RESISTANCE_MODE
protected Future<?>	setting	Future to block on while settling
protected static final String	SOURCE_MODE
protected boolean	switchOnAtNextMove	Flag indicating the next time rawAsynchronousMoveTo(Object) is called the output will be switched on
protected static final String	VOLTAGE_LEVEL_SETPOINT

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

Method Summary

Modifier and Type	Method	Description
void	atPointEnd()	Called on every Scannable at the end of every data point, for scans which are broken down into individual points (i.e.
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
protected void	checkStatusAndThrow()	The idea is to all this whenever an current or voltage limit might be reached.
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 abstract double	getActualCurrent()
protected abstract double	getActualResistance()
protected abstract double	getActualVoltage()
long	getAdditionalFirstPointSettleTimeMs()	The additional delay to be applied on the first point of the scan after setting the demand.
protected double	getDemand()
protected abstract double	getDemandCurrent()
protected abstract double	getDemandVoltage()
protected NexusTreeProvider	getDetectorData()
NexusTreeProvider	getFileStructure()
abstract AbstractKeithley2600Series.ResistanceMode	getResistanceMode()
Set<AbstractKeithley2600Series.ResistanceMode>	getResistanceModes()
long	getSettleTime()
protected abstract AbstractKeithley2600Series.SourceMode	getSourceMode()
Set<AbstractKeithley2600Series.SourceMode>	getSourceModes()
long	getSwitchOnDelayTimeMs()
boolean	isBusy()	Check if the Scannable is moving/operating.
abstract boolean	isOutputOn()
protected abstract void	outputOff()
protected abstract void	outputOn()
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	setAdditionalFirstPointSettleTimeMs(long additionalFirstPointSettleTimeMs)	The additional delay to be applied on the first point of the scan after setting the demand.
protected void	setDetectorDataEntryMap(HashMap<?,?>... data)
protected abstract void	setOutputDemandAndWaitToSettle(double demand)
void	setResistanceMode(String mode)
protected abstract void	setResistanceMode(AbstractKeithley2600Series.ResistanceMode mode)
void	setSettleTime(long settleTime)
void	setSourceMode(String mode)
protected abstract void	setSourceMode(AbstractKeithley2600Series.SourceMode mode)
void	setSwitchOnDelayTimeMs(long switchOnDelayTimeMs)
protected void	setupNamesAndFormat()
void	stop()	Stop the current move/operation.
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status
protected void	waitForSettling()
protected void	waitForSwitchOn()
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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

Field Details

SOURCE_MODE

protected static final String SOURCE_MODE

See Also:

• Constant Field Values

MEAN_CURRENT

protected static final String MEAN_CURRENT

See Also:

• Constant Field Values

MEAN_VOLTAGE

protected static final String MEAN_VOLTAGE

See Also:

• Constant Field Values

VOLTAGE_LEVEL_SETPOINT

protected static final String VOLTAGE_LEVEL_SETPOINT

See Also:

• Constant Field Values

CURRENT_LEVEL_SETPOINT

protected static final String CURRENT_LEVEL_SETPOINT

See Also:

• Constant Field Values

INTEGRATION_TIME

protected static final String INTEGRATION_TIME

See Also:

• Constant Field Values

RESISTANCE_MODE

protected static final String RESISTANCE_MODE

See Also:

• Constant Field Values

NUMBER_OF_READINGS

protected static final String NUMBER_OF_READINGS

See Also:

• Constant Field Values

DWELL_TIME

protected static final String DWELL_TIME

See Also:

• Constant Field Values

detectorDataEntryMap

protected HashMap<String,DetectorDataEntry<?>> detectorDataEntryMap

dataMapToWrite

protected final HashMap<String,Object> dataMapToWrite

limitStatus

protected AbstractKeithley2600Series.Status limitStatus

The status showing if the voltage or current limits are reached

setting

protected Future<?> setting

Future to block on while settling

switchOnAtNextMove

protected boolean switchOnAtNextMove

Flag indicating the next time rawAsynchronousMoveTo(Object) is called the output will be switched on

isFirstPoint

protected boolean isFirstPoint

Flag indicating whether we are on the first point

Constructor Details

AbstractKeithley2600Series

public AbstractKeithley2600Series()

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 ConfigurableBase

Throws:

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

getSourceModes

public Set<AbstractKeithley2600Series.SourceMode> getSourceModes()

getResistanceModes

public Set<AbstractKeithley2600Series.ResistanceMode> getResistanceModes()

toFormattedString

public String toFormattedString()

Description copied from interface: Scannable

Returns a string representation of the Scannable and its current position/value/status

Typically should return:

name : position

or for detectors, name : status

If the position/status cannot be determined, the function should return Scannable.VALUE_UNAVAILABLE in its place.

Specified by:

toFormattedString in interface Scannable

Overrides:

toFormattedString in class ScannableBase

Returns:

string as defined above

getSourceMode

protected abstract AbstractKeithley2600Series.SourceMode getSourceMode()
                                                                throws DeviceException

Throws:

DeviceException

waitForSettling

protected void waitForSettling()

waitForSwitchOn

protected void waitForSwitchOn()

checkStatusAndThrow

protected void checkStatusAndThrow()
                            throws DeviceException

The idea is to all this whenever an current or voltage limit might be reached. If it is this will throw aborting the ongoing request or scan.

Throws:

DeviceException

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 ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

getActualResistance

protected abstract double getActualResistance()
                                       throws DeviceException

Throws:

DeviceException

getActualCurrent

protected abstract double getActualCurrent()
                                    throws DeviceException

Throws:

DeviceException

getActualVoltage

protected abstract double getActualVoltage()
                                    throws DeviceException

Throws:

DeviceException

getDemand

protected double getDemand()
                    throws DeviceException

Throws:

DeviceException

getDemandCurrent

protected abstract double getDemandCurrent()
                                    throws DeviceException

Throws:

DeviceException

getDemandVoltage

protected abstract double getDemandVoltage()
                                    throws DeviceException

Throws:

DeviceException

setupNamesAndFormat

protected void setupNamesAndFormat()

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

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

setOutputDemandAndWaitToSettle

protected abstract void setOutputDemandAndWaitToSettle(double demand)

waitWhileBusy

public void waitWhileBusy()
                   throws DeviceException,
InterruptedException

Description copied from class: ScannableBase

Returns when operation carried out by moveTo has completed If this is to be overriden, isBusy must also be valid. Although the pos and scan command currently use this method to determine if the Scannable is busy, this must not be relied upon.

Specified by:

waitWhileBusy in interface Scannable

Overrides:

waitWhileBusy in class ScannableBase

Throws:

DeviceException

InterruptedException

outputOff

protected abstract void outputOff()
                           throws DeviceException

Throws:

DeviceException

outputOn

protected abstract void outputOn()
                          throws DeviceException

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

setSourceMode

public void setSourceMode(String mode)
                   throws DeviceException

Throws:

DeviceException

setSourceMode

protected abstract void setSourceMode(AbstractKeithley2600Series.SourceMode mode)
                               throws DeviceException

Throws:

DeviceException

setResistanceMode

public void setResistanceMode(String mode)
                       throws DeviceException

Throws:

DeviceException

setResistanceMode

protected abstract void setResistanceMode(AbstractKeithley2600Series.ResistanceMode mode)
                                   throws DeviceException

Throws:

DeviceException

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

atPointEnd

public void atPointEnd()
                throws DeviceException

Description copied from class: ScannableBase

Called on every Scannable at the end of every data point, for scans which are broken down into individual points (i.e. non-continous scans) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atPointEnd in interface Scannable

Overrides:

atPointEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atPointEnd()

getResistanceMode

public abstract AbstractKeithley2600Series.ResistanceMode getResistanceMode()
                                                                     throws DeviceException

Throws:

DeviceException

isOutputOn

public abstract boolean isOutputOn()
                            throws DeviceException

Throws:

DeviceException

getSettleTime

public long getSettleTime()

Returns:

The delay applied after the demand is changed.

setSettleTime

public void setSettleTime(long settleTime)

Parameters:

settleTime - The delay to be applied after the demand is changed.

getSwitchOnDelayTimeMs

public long getSwitchOnDelayTimeMs()

Returns:

The delay applied after the source is switched on.

setSwitchOnDelayTimeMs

public void setSwitchOnDelayTimeMs(long switchOnDelayTimeMs)

Parameters:

switchOnDelayTimeMs - The delay applied after the source is switched on.

getAdditionalFirstPointSettleTimeMs

public long getAdditionalFirstPointSettleTimeMs()

The additional delay to be applied on the first point of the scan after setting the demand. *

setAdditionalFirstPointSettleTimeMs

public void setAdditionalFirstPointSettleTimeMs(long additionalFirstPointSettleTimeMs)

The additional delay to be applied on the first point of the scan after setting the demand.

Parameters:

additionalFirstPointSettleTimeMs -

getFileStructure

public NexusTreeProvider getFileStructure()
                                   throws DeviceException

Throws:

DeviceException

setDetectorDataEntryMap

protected void setDetectorDataEntryMap(HashMap<?,?>... data)
                                throws DeviceException

Throws:

DeviceException

getDetectorData

protected NexusTreeProvider getDetectorData()