Package uk.ac.gda.devices.insitu.samplechanger

Class PlateSampleChangerBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

uk.ac.gda.devices.insitu.samplechanger.PlateSampleChangerBase

All Implemented Interfaces:

Device, Stoppable, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver, BlockedPositions, SampleChanger

public class PlateSampleChangerBase
extends DeviceBase
implements SampleChanger, gda.observable.IObserver

Field Summary

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.px.sampleChanger.SampleChanger

APPROVERNAME, ATTRIBUTE_IS_SOAKING, EMPTY

Constructor Summary

Constructors

Constructor	Description
PlateSampleChangerBase()

Method Summary

Modifier and Type	Method	Description
String	getActionApproverName()
String	getBarcode()	For SampleChangers which are set to read barcodes, returns as a string the barcode of the sample mounted during the last load operation.
Set<Sample>	getBlockedPositions()
PlateController	getController()
int	getHolder()	Returns the number of the holder of the current loaded sample.
String	getHolderType()	Returns a string representing the type of puck in use
PlateInventory	getInventory()
int	getNumberOfHolders()	Returns the number of holders (pucks) over all available dewars to load from.
boolean	getReadingBarcodes()
int	getSample()	Get the position in its holder of the currently loaded sample.
int	getSamplesInHolder(int holder)	Returns the number of samples in the specified holder (puck).
SampleChangerStatus	getStatus()
String	getTypeString()	Returns a string of the Java class of the type of this sample changer.
boolean	isCentreRequired()	Returns true if the user needs to centre the crystal.
boolean	isEnabled()	Returns true if this sample changer is in use for loading samples.
boolean	isPositionBlocked(int holder, int sample)
boolean	isSampleLoaded()	Returns true if a sample is in the sample position on the beamline.
boolean	isSampleLoaded(int holder, int sample)	Returns true if loaded sample has the specified index.
void	load(int holder, int sample)	Load a sample.
void	setActionApproverName(String actionApproverName)
void	setCentreRequired(boolean centringRequired)	Sets the centre required flag.
void	setController(PlateController controller)
void	setEnabled(boolean isEnabled)	Sets if the sample changer is currently in use.
void	setHolderType(String puckType)	Sets a string representing the type of puck in use e.g.
void	setInventory(PlateInventory inventory)
void	setLoadedSample(int holder, int sample)	Sets the holder and sample numbers of the loaded sample.
void	setNumberOfHolders(int numberOfHolders)	Sets the number of total holders (pucks/magazines/plates etc.) that the sample changer can load from
void	setReadingBarcodes(boolean readDuringLoad)	Sets whether to read barcodes during each load operation
void	setSamplesInHolder(int holder, int samples)	Sets the number of samples in the specified holder.
void	stop()	Stops the current operation.
void	unload()	Unloads the current sample without loading a new one.
void	update(Object source, Object arg)
boolean	waitForIdle()	Returns when the sample changer has finished its current operation.

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

configure, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

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

PlateSampleChangerBase

public PlateSampleChangerBase()

Method Details

getActionApproverName

public String getActionApproverName()
                             throws DeviceException

Specified by:

getActionApproverName in interface SampleChanger

Returns:

name of the action approver object in the top-level Jython namespace

Throws:

DeviceException

getBarcode

public String getBarcode()
                  throws DeviceException

Description copied from interface: SampleChanger

For SampleChangers which are set to read barcodes, returns as a string the barcode of the sample mounted during the last load operation.

Specified by:

getBarcode in interface SampleChanger

Returns:

the barcode of the currently mounted sample

Throws:

DeviceException

getController

public PlateController getController()

getHolder

public int getHolder()
              throws DeviceException

Description copied from interface: SampleChanger

Returns the number of the holder of the current loaded sample.

Specified by:

getHolder in interface SampleChanger

Returns:

int

Throws:

DeviceException

getHolderType

public String getHolderType()
                     throws DeviceException

Description copied from interface: SampleChanger

Returns a string representing the type of puck in use

Specified by:

getHolderType in interface SampleChanger

Returns:

string

Throws:

DeviceException

getInventory

public PlateInventory getInventory()

getNumberOfHolders

public int getNumberOfHolders()
                       throws DeviceException

Description copied from interface: SampleChanger

Returns the number of holders (pucks) over all available dewars to load from.

Specified by:

getNumberOfHolders in interface SampleChanger

Returns:

int

Throws:

DeviceException

getReadingBarcodes

public boolean getReadingBarcodes()
                           throws DeviceException

Specified by:

getReadingBarcodes in interface SampleChanger

Returns:

true if the samplechanger will read barcodes during loading.

Throws:

DeviceException

getSample

public int getSample()
              throws DeviceException

Description copied from interface: SampleChanger

Get the position in its holder of the currently loaded sample.

Specified by:

getSample in interface SampleChanger

Returns:

int

Throws:

DeviceException

getSamplesInHolder

public int getSamplesInHolder(int holder)
                       throws DeviceException

Description copied from interface: SampleChanger

Returns the number of samples in the specified holder (puck).

Specified by:

getSamplesInHolder in interface SampleChanger

Parameters:

holder - the holder number (starting from 1)

Returns:

the number of samples in that holder

Throws:

DeviceException

getStatus

public SampleChangerStatus getStatus()
                              throws DeviceException

Specified by:

getStatus in interface SampleChanger

Returns:

the current status of the sample changer as a SampleChangerStatus object

Throws:

DeviceException

getTypeString

public String getTypeString()
                     throws DeviceException

Description copied from interface: SampleChanger

Returns a string of the Java class of the type of this sample changer.

Specified by:

getTypeString in interface SampleChanger

Returns:

java.lang.String

Throws:

DeviceException

isCentreRequired

public boolean isCentreRequired()
                         throws DeviceException

Description copied from interface: SampleChanger

Returns true if the user needs to centre the crystal.

Specified by:

isCentreRequired in interface SampleChanger

Throws:

DeviceException

isEnabled

public boolean isEnabled()
                  throws DeviceException

Description copied from interface: SampleChanger

Returns true if this sample changer is in use for loading samples.

Specified by:

isEnabled in interface SampleChanger

Returns:

boolean

Throws:

DeviceException

isSampleLoaded

public boolean isSampleLoaded()
                       throws DeviceException

Description copied from interface: SampleChanger

Returns true if a sample is in the sample position on the beamline.

Specified by:

isSampleLoaded in interface SampleChanger

Returns:

boolean

Throws:

DeviceException

isSampleLoaded

public boolean isSampleLoaded(int holder,
 int sample)
                       throws DeviceException

Description copied from interface: SampleChanger

Returns true if loaded sample has the specified index.

Specified by:

isSampleLoaded in interface SampleChanger

Parameters:

holder - the holder index (≥1)

sample - the sample index (≥1)

Returns:

boolean

Throws:

DeviceException

load

public void load(int holder,
 int sample)
          throws DeviceException

Description copied from interface: SampleChanger

Load a sample.

Specified by:

load in interface SampleChanger

Parameters:

holder - the holder number (≥1)

sample - the sample number (≥1)

Throws:

DeviceException

setActionApproverName

public void setActionApproverName(String actionApproverName)
                           throws DeviceException

Specified by:

setActionApproverName in interface SampleChanger

Parameters:

actionApproverName -

Throws:

DeviceException

setCentreRequired

public void setCentreRequired(boolean centringRequired)
                       throws DeviceException

Description copied from interface: SampleChanger

Sets the centre required flag. This enables the detector to be told when manual centring has been successfully completed.

Specified by:

setCentreRequired in interface SampleChanger

Parameters:

centringRequired -

Throws:

DeviceException

setController

public void setController(PlateController controller)

setEnabled

public void setEnabled(boolean isEnabled)
                throws DeviceException

Description copied from interface: SampleChanger

Sets if the sample changer is currently in use.

Specified by:

setEnabled in interface SampleChanger

Parameters:

isEnabled -

Throws:

DeviceException

setHolderType

public void setHolderType(String puckType)
                   throws DeviceException

Description copied from interface: SampleChanger

Sets a string representing the type of puck in use e.g. "Rigaku"

Specified by:

setHolderType in interface SampleChanger

Parameters:

puckType -

Throws:

DeviceException

setInventory

public void setInventory(PlateInventory inventory)

setLoadedSample

public void setLoadedSample(int holder,
 int sample)
                     throws DeviceException

Description copied from interface: SampleChanger

Sets the holder and sample numbers of the loaded sample. To be used if a sample is manually mounted onto the sample changer.

Specified by:

setLoadedSample in interface SampleChanger

Parameters:

holder - the holder number

sample - the sample number

Throws:

DeviceException

setNumberOfHolders

public void setNumberOfHolders(int numberOfHolders)
                        throws DeviceException

Description copied from interface: SampleChanger

Sets the number of total holders (pucks/magazines/plates etc.) that the sample changer can load from

Specified by:

setNumberOfHolders in interface SampleChanger

Parameters:

numberOfHolders -

Throws:

DeviceException

setReadingBarcodes

public void setReadingBarcodes(boolean readDuringLoad)
                        throws DeviceException

Description copied from interface: SampleChanger

Sets whether to read barcodes during each load operation

Specified by:

setReadingBarcodes in interface SampleChanger

Parameters:

readDuringLoad -

Throws:

DeviceException

setSamplesInHolder

public void setSamplesInHolder(int holder,
 int samples)
                        throws DeviceException

Description copied from interface: SampleChanger

Sets the number of samples in the specified holder. Used when changing the puck type mid-experiment.

Specified by:

setSamplesInHolder in interface SampleChanger

Parameters:

holder - the holder number (starting from 1)

samples - the number of samples in that holder

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from interface: Stoppable

Stops the current operation.

Specified by:

stop in interface SampleChanger

Specified by:

stop in interface Stoppable

Throws:

DeviceException

unload

public void unload()
            throws DeviceException

Description copied from interface: SampleChanger

Unloads the current sample without loading a new one.

Specified by:

unload in interface SampleChanger

Throws:

DeviceException

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

waitForIdle

public boolean waitForIdle()
                    throws DeviceException

Description copied from interface: SampleChanger

Returns when the sample changer has finished its current operation.

Specified by:

waitForIdle in interface SampleChanger

Returns:

true if the current operation was successful

Throws:

DeviceException

isPositionBlocked

public boolean isPositionBlocked(int holder,
 int sample)

Specified by:

isPositionBlocked in interface BlockedPositions

getBlockedPositions

public Set<Sample> getBlockedPositions()

Specified by:

getBlockedPositions in interface BlockedPositions