Package gda.px.sampleChanger

Interface SampleChanger

All Superinterfaces:

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

All Known Subinterfaces:

IJActorSampleChanger

All Known Implementing Classes:

ActorSampleChanger, DummyJActorSampleChanger, DummyJCameramanSampleChanger, DummySampleChanger, JActorSampleChanger, OscarSampleChanger, PlateSampleChangerBase, SampleChangerBase

public interface SampleChanger
extends Device, Stoppable, BlockedPositions

Interface for automated sample exchange systems. It is assumed that samples are identified by holder and position numbers.

Sample changers also assumed to be able to automatically centre their sample via control of an XYZ sample mounting stage.

Sample changers can be enabled/disabled at runtime to allow for switching between manual and automated sample loading. Implementations should set the state to INITIALISING while the robot is initialising, and go back to the IDLE state when this is finished. If an error occurs, the ERROR state should be used.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPROVERNAME	The name of the ActionApprover object located in the top-level Jython namespace which is used to test if sample changer movements are possible due to hardware interlocks
static final String	ATTRIBUTE_IS_SOAKING
static final int	EMPTY	Value to be used for the holder number or sample number if no sample is loaded.

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.
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
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	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	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	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.
boolean	waitForIdle()	Returns when the sample changer has finished its current operation.

Methods inherited from interface gda.px.sampleChanger.BlockedPositions

getBlockedPositions, isPositionBlocked

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

Field Details

ATTRIBUTE_IS_SOAKING

static final String ATTRIBUTE_IS_SOAKING

See Also:

• Constant Field Values

APPROVERNAME

static final String APPROVERNAME

The name of the ActionApprover object located in the top-level Jython namespace which is used to test if sample changer movements are possible due to hardware interlocks

See Also:

• Constant Field Values

EMPTY

static final int EMPTY

Value to be used for the holder number or sample number if no sample is loaded.

See Also:

• Constant Field Values

Method Details

getBarcode

String getBarcode()
           throws DeviceException

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

Returns:

the barcode of the currently mounted sample

Throws:

DeviceException

getHolder

int getHolder()
       throws DeviceException

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

Returns:

int

Throws:

DeviceException

getTypeString

String getTypeString()
              throws DeviceException

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

Returns:

java.lang.String

Throws:

DeviceException

getNumberOfHolders

int getNumberOfHolders()
                throws DeviceException

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

Returns:

int

Throws:

DeviceException

getHolderType

String getHolderType()
              throws DeviceException

Returns a string representing the type of puck in use

Returns:

string

Throws:

DeviceException

getReadingBarcodes

boolean getReadingBarcodes()
                    throws DeviceException

Returns:

true if the samplechanger will read barcodes during loading.

Throws:

DeviceException

getSample

int getSample()
       throws DeviceException

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

Returns:

int

Throws:

DeviceException

getSamplesInHolder

int getSamplesInHolder(int holder)
                throws DeviceException

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

Parameters:

holder - the holder number (starting from 1)

Returns:

the number of samples in that holder

Throws:

DeviceException

isCentreRequired

boolean isCentreRequired()
                  throws DeviceException

Returns true if the user needs to centre the crystal.

Throws:

DeviceException

isEnabled

boolean isEnabled()
           throws DeviceException

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

Returns:

boolean

Throws:

DeviceException

setNumberOfHolders

void setNumberOfHolders(int numberOfHolders)
                 throws DeviceException

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

Parameters:

numberOfHolders -

Throws:

DeviceException

setHolderType

void setHolderType(String puckType)
            throws DeviceException

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

Parameters:

puckType -

Throws:

DeviceException

setSamplesInHolder

void setSamplesInHolder(int holder,
 int samples)
                 throws DeviceException

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

Parameters:

holder - the holder number (starting from 1)

samples - the number of samples in that holder

Throws:

DeviceException

isSampleLoaded

boolean isSampleLoaded()
                throws DeviceException

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

Returns:

boolean

Throws:

DeviceException

isSampleLoaded

boolean isSampleLoaded(int holder,
 int sample)
                throws DeviceException

Returns true if loaded sample has the specified index.

Parameters:

holder - the holder index (≥1)

sample - the sample index (≥1)

Returns:

boolean

Throws:

DeviceException

load

void load(int holder,
 int sample)
   throws DeviceException

Load a sample.

Parameters:

holder - the holder number (≥1)

sample - the sample number (≥1)

Throws:

DeviceException

getStatus

SampleChangerStatus getStatus()
                       throws DeviceException

Returns:

the current status of the sample changer as a SampleChangerStatus object

Throws:

DeviceException

setCentreRequired

void setCentreRequired(boolean centringRequired)
                throws DeviceException

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

Parameters:

centringRequired -

Throws:

DeviceException

setLoadedSample

void setLoadedSample(int holder,
 int sample)
              throws DeviceException

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

Parameters:

holder - the holder number

sample - the sample number

Throws:

DeviceException

setEnabled

void setEnabled(boolean isEnabled)
         throws DeviceException

Sets if the sample changer is currently in use.

Parameters:

isEnabled -

Throws:

DeviceException

setReadingBarcodes

void setReadingBarcodes(boolean readDuringLoad)
                 throws DeviceException

Sets whether to read barcodes during each load operation

Parameters:

readDuringLoad -

Throws:

DeviceException

stop

void stop()
   throws DeviceException

Description copied from interface: Stoppable

Stops the current operation.

Specified by:

stop in interface Stoppable

Throws:

DeviceException

unload

void unload()
     throws DeviceException

Unloads the current sample without loading a new one.

Throws:

DeviceException

waitForIdle

boolean waitForIdle()
             throws DeviceException

Returns when the sample changer has finished its current operation.

Returns:

true if the current operation was successful

Throws:

DeviceException

setActionApproverName

void setActionApproverName(String actionApproverName)
                    throws DeviceException

Parameters:

actionApproverName -

Throws:

DeviceException

getActionApproverName

String getActionApproverName()
                      throws DeviceException

Returns:

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

Throws:

DeviceException