Package gda.px.sampleop

Class SampleOperationStateStore

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.px.sampleop.SampleOperationStateStore

All Implemented Interfaces:

Configurable, Findable, SampleOperationStateProvider

public class SampleOperationStateStore
extends FindableConfigurableBase
implements SampleOperationStateProvider

Where the beamline does not have an autonomous sample changer robot responsible for the complete operation, we maintain state information so that appropriate action can be taken, especially if an operation is aborted or an error occurs. This class maintains information about the current sample changer operation (if there is one), via several objects: * SampleStore targetStore - maintains known attributes of the target sample * Scannable targetState - the state of the sample that is the target of the sample changer operation * Scannable gripperState - the state of the gripper in the operation currently executed by the changer

Constructor Summary

Constructors

Constructor	Description
SampleOperationStateStore()

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.
GripperState	getGripperState()
EnumPositioner	getGripperStateProvider()
GripState	getGripState()
EnumPositioner	getGripStateProvider()
SampleOperationsState	getSampleOperationsState()
Sample	getTargetSample()
EnumPositioner	getTargetStateProvider()
SampleStore	getTargetStore()
boolean	isConfigured()	Checks to see if the object is already configured.
void	setGripperStateProvider(EnumPositioner gripperState)
void	setGripStateProvider(EnumPositioner gripState)
void	setTargetStateProvider(EnumPositioner targetStateProvide)
void	setTargetStore(SampleStore targetStore)

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, 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.Findable

getName, setName

Constructor Details

SampleOperationStateStore

public SampleOperationStateStore()

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

getGripperState

public GripperState getGripperState()

Specified by:

getGripperState in interface SampleOperationStateProvider

getGripperStateProvider

public EnumPositioner getGripperStateProvider()

getGripState

public GripState getGripState()

Specified by:

getGripState in interface SampleOperationStateProvider

getGripStateProvider

public EnumPositioner getGripStateProvider()

getSampleOperationsState

public SampleOperationsState getSampleOperationsState()

Specified by:

getSampleOperationsState in interface SampleOperationStateProvider

getTargetSample

public Sample getTargetSample()

Specified by:

getTargetSample in interface SampleOperationStateProvider

getTargetStateProvider

public EnumPositioner getTargetStateProvider()

getTargetStore

public SampleStore getTargetStore()

isConfigured

public boolean isConfigured()

Description copied from interface: Configurable

Checks to see if the object is already configured.

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class ConfigurableBase

Returns:

return true if configured false otherwise

setGripperStateProvider

public void setGripperStateProvider(EnumPositioner gripperState)

setGripStateProvider

public void setGripStateProvider(EnumPositioner gripState)

setTargetStateProvider

public void setTargetStateProvider(EnumPositioner targetStateProvide)

setTargetStore

public void setTargetStore(SampleStore targetStore)