Package gda.mx.samplechanger.actor

Class ActorSampleChanger

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.px.sampleChanger.SampleChangerBase

gda.mx.samplechanger.actor.ActorSampleChanger

All Implemented Interfaces:

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

@ServiceInterface(IJActorSampleChanger.class)
public class ActorSampleChanger
extends SampleChangerBase
implements PXSampleChanger, IJActorSampleChanger, SamplePresentMonitor, gda.observable.IObserver

Field Summary

Fields inherited from class gda.px.sampleChanger.SampleChangerBase

actionApproverName, centreRequired, holder, holderType, isEnabled, numberOfHolders, readingBarcodes, sample, samplesPerHolder, state, type

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

Method Summary

Modifier and Type	Method	Description
void	abort()
void	autoDryRobotIfCan()
void	blockPosition(int holder, int sample)
void	centrelid(int lidNumber)	Doesn't actually ask controller to do anything as EPICS/robot program handles this for soak, etc.
void	clearSample()	in IJActorSampleChanger I24's keyence_autocenter.py also expects this
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	dispose()
void	dry()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
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()
Integer	getControlErrorCode()	Used by sample_control script to produce meaningful Exception messages
ActorSampleChangerController	getController()
int	getHolder()	Returns the number of the holder of the current loaded sample.
int[]	getHolderAndSample()	IJActorSampleChanger declaration overrides SampleChanger and throws DeviceException
rigaku.jcameraman.RobotClient.RobotLocation	getLocation()
int	getNumberOfPlates()
int	getProgramErrorCode()	Used by sample_control script to produce meaningful Exception messages
String	getPuckName(int position)
int	getSample()	Get the position in its holder of the currently loaded sample.
boolean	getSoakAfterOperation()
int	getSpecialPinPuckNumber()
void	gotoWait()
boolean	isPositionBlocked(int holder, int sample)
boolean	isSampleLoaded()	Returns true if a sample is in the sample position on the beamline.
boolean	isSamplePresent()
void	load(int holder, int sample)	Load a sample.
void	reconfigure()	Re-initialisation of values and states.
void	setAttribute(String attributeName, Object value)	copied from JActorSampleChanger with intention of trapping what should be method calls to add to PXSampleChanger interface
void	setController(ActorSampleChangerController theController)
void	setNumberOfPlates(int numberOfPlates)
void	setSoakAfterOperation(boolean soakAfterOperation)
void	setSpecialPinPuckNumber(int specialPinPuckNumber)	From JActorSampleChanger: For client use; e.g.
void	soak()
void	soak(int dewarNumber)
void	store(int container, int sample)
void	unblockPosition(int holder, int sample)
void	unload()	Unloads the current sample without loading a new one.
void	update(Object source, Object arg)

Methods inherited from class gda.px.sampleChanger.SampleChangerBase

getActionApproverName, getHolderType, getNumberOfHolders, getReadingBarcodes, getSamplesInHolder, getStatus, getTypeString, isCentreRequired, isEnabled, isHolderInRange, isSampleInRange, isSampleLoaded, setActionApproverName, setCentreRequired, setEnabled, setHolderType, setLoadedSample, setNumberOfHolders, setReadingBarcodes, setSamplesInEveryHolder, setSamplesInHolder, setState, setTestState, setType, stop, testLoadSafe, waitForIdle

Methods inherited from class gda.device.DeviceBase

addIObserver, close, 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, toString, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured

Methods inherited from interface gda.device.Device

close, 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.mx.samplechanger.actor.PXSampleChanger

setSamplesInEveryHolder

Methods inherited from interface gda.px.sampleChanger.SampleChanger

getActionApproverName, getHolderType, getNumberOfHolders, getReadingBarcodes, getSamplesInHolder, getStatus, getTypeString, isCentreRequired, isEnabled, isSampleLoaded, setActionApproverName, setCentreRequired, setEnabled, setHolderType, setLoadedSample, setNumberOfHolders, setReadingBarcodes, setSamplesInHolder, stop, waitForIdle

Methods inherited from interface gda.px.sampleChanger.SamplePresentMonitor

isEnabled

Constructor Details

ActorSampleChanger

public ActorSampleChanger()

Method Details

getController

public ActorSampleChangerController getController()

setController

public void setController(ActorSampleChangerController theController)

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getProgramErrorCode

public int getProgramErrorCode()

Used by sample_control script to produce meaningful Exception messages

getControlErrorCode

public Integer getControlErrorCode()

Used by sample_control script to produce meaningful Exception messages

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

reconfigure

public void reconfigure()

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

getPuckName

public String getPuckName(int position)

Specified by:

getPuckName in interface IJActorSampleChanger

getHolderAndSample

public int[] getHolderAndSample()
                         throws DeviceException

Description copied from interface: PXSampleChanger

IJActorSampleChanger declaration overrides SampleChanger and throws DeviceException

Specified by:

getHolderAndSample in interface IJActorSampleChanger

Specified by:

getHolderAndSample in interface PXSampleChanger

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

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

centrelid

public void centrelid(int lidNumber)
               throws DeviceException

Doesn't actually ask controller to do anything as EPICS/robot program handles this for soak, etc.

Specified by:

centrelid in interface IJActorSampleChanger

Specified by:

centrelid in interface PXSampleChanger

Throws:

DeviceException

getLocation

public rigaku.jcameraman.RobotClient.RobotLocation getLocation()
                                                        throws DeviceException

Specified by:

getLocation in interface IJActorSampleChanger

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

clearSample

public void clearSample()
                 throws DeviceException

Description copied from interface: PXSampleChanger

in IJActorSampleChanger I24's keyence_autocenter.py also expects this

Specified by:

clearSample in interface IJActorSampleChanger

Specified by:

clearSample in interface PXSampleChanger

Throws:

DeviceException

setAttribute

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

copied from JActorSampleChanger with intention of trapping what should be method calls to add to PXSampleChanger interface

Specified by:

setAttribute in interface Device

Overrides:

setAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

store

public void store(int container,
 int sample)

getAttribute

public Object getAttribute(String attributeName)
                    throws DeviceException

Description copied from interface: Device

Get the value of the specified attribute

Specified by:

getAttribute in interface Device

Overrides:

getAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

Returns:

the value of the attribute as an Object type

Throws:

DeviceException - if an attribute cannot be retrieved

dispose

public void dispose()
             throws DeviceException

Specified by:

dispose in interface PXSampleChanger

Throws:

DeviceException

abort

public void abort()
           throws DeviceException

Specified by:

abort in interface PXSampleChanger

Throws:

DeviceException

dry

public void dry()
         throws DeviceException

Specified by:

dry in interface PXSampleChanger

Throws:

DeviceException

soak

public void soak()
          throws DeviceException

Specified by:

soak in interface PXSampleChanger

Throws:

DeviceException

gotoWait

public void gotoWait()
              throws DeviceException

Specified by:

gotoWait in interface PXSampleChanger

Throws:

DeviceException

setSoakAfterOperation

public void setSoakAfterOperation(boolean soakAfterOperation)

getSoakAfterOperation

public boolean getSoakAfterOperation()

autoDryRobotIfCan

public void autoDryRobotIfCan()

isSampleLoaded

public boolean isSampleLoaded()

Description copied from interface: SampleChanger

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

Specified by:

isSampleLoaded in interface SampleChanger

Overrides:

isSampleLoaded in class SampleChangerBase

Returns:

boolean

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

Overrides:

getHolder in class SampleChangerBase

Returns:

int

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

Overrides:

getSample in class SampleChangerBase

Returns:

int

Throws:

DeviceException

getNumberOfPlates

public int getNumberOfPlates()

setNumberOfPlates

public void setNumberOfPlates(int numberOfPlates)

Specified by:

setNumberOfPlates in interface PXSampleChanger

getSpecialPinPuckNumber

public int getSpecialPinPuckNumber()

Specified by:

getSpecialPinPuckNumber in interface IJActorSampleChanger

setSpecialPinPuckNumber

public void setSpecialPinPuckNumber(int specialPinPuckNumber)

Description copied from interface: PXSampleChanger

From JActorSampleChanger: For client use; e.g. "load puck 6 position 1" means "load special pin 1"

Specified by:

setSpecialPinPuckNumber in interface PXSampleChanger

isSamplePresent

public boolean isSamplePresent()

Specified by:

isSamplePresent in interface SamplePresentMonitor

soak

public void soak(int dewarNumber)
          throws DeviceException

Specified by:

soak in interface IJActorSampleChanger

Throws:

DeviceException

blockPosition

public void blockPosition(int holder,
 int sample)

unblockPosition

public void unblockPosition(int holder,
 int sample)

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