Package uk.ac.gda.component.beamline.common.gonio

Class DiffractometerBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.scannablegroup.ScannableGroup

gda.device.scannable.scannablegroup.ScannableGroupNamed

uk.ac.gda.component.model.core.AssemblyBase

uk.ac.gda.component.beamline.common.gonio.GonioBase

uk.ac.gda.component.beamline.common.gonio.DiffractometerBase

All Implemented Interfaces:

Device, Scannable, IScannableGroup, IScannableGroupNamed, Stoppable, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver, Diffractometer, Gonio, GonioService, Assembly, CoordinatesMove, IndexMove, IndexPositioner

public class DiffractometerBase
extends GonioBase
implements Diffractometer

Nested Class Summary

Nested classes/interfaces inherited from interface uk.ac.gda.component.beamline.gonio.Diffractometer

Diffractometer.DiffAxis

Nested classes/interfaces inherited from interface uk.ac.gda.component.beamline.gonio.GonioService

GonioService.Axis

Field Summary

Fields inherited from class uk.ac.gda.component.beamline.common.gonio.GonioBase

INDEX_ACTIVE, INDEX_PARK

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, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
DiffractometerBase()

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.
String	getScannableDetectorDistance()
String	getScannableKappa()
String	getScannableName(Diffractometer.DiffAxis axis)
String	getScannablePhi()
String	getScannableTwoTheta()
GonioService	moveDetectorDistance(double distance)
GonioService	moveKappa(double kappa)
GonioService	movePhi(double phi)
GonioService	moveTwoTheta(double twotheta)
Double	readDetectorDistance()
Double	readKappa()
Double	readPhi()
Double	readTwoTheta()
void	setScannableDetectorDistance(String scannableDetectorDistance)
void	setScannableKappa(String scannableKappa)
void	setScannablePhi(String scannablePhi)
void	setScannableTwoTheta(String scannableTwoTheta)

Methods inherited from class uk.ac.gda.component.beamline.common.gonio.GonioBase

activate, conditionalAddScannable, getAssembly, getScannableName, getScannableOmega, getScannableTableX, getScannableTableY, getScannableTableZ, getScannableX, getScannableY, getScannableZ, moveOmega, moveTableX, moveTableY, moveTableZ, moveTo, moveX, moveY, moveZ, park, readAxis, readOmega, readTableX, readTableY, readTableZ, readX, readY, readZ, reconfigure, setScannableOmega, setScannableTableX, setScannableTableY, setScannableTableZ, setScannableX, setScannableY, setScannableZ

Methods inherited from class uk.ac.gda.component.model.core.AssemblyBase

addActionRule, addDefinedCoordinates, addDefinedCoordinates, addDevice, addGroupMemberByName, asynchronousMoveTo, asynchronousMoveToCoordinates, asynchronousMoveToDefined, asynchronousMoveToIndex, checkActionRules, checkAssemblies, checkAssemblies, checkMovementValid, clearConfiguration, convertPositionArrayToCoordinates, dispose, disposeSubAssemblies, getAdapter, getAllDevices, getCurrentCoordinates, getDefinedCoordinates, getDefinedCoordinatesNames, getDevice, getGroupMemberByName, getGroupMembersNames, getSubAssemblies, isAt, isAt, isAtIndex, isEnabled, isLockedToIndexPositions, isScannable, isScannableAt, isVisited, moveToCoordinates, moveToDefined, moveToIndex, raiseVeto, removeApprover, removeGroupMemberName, setDefinedCoordinates, setEnabled, setGroupMembersNamesWithArray, setGroupMembersNamesWithList, setVisited, toFormattedString, toString, updateCoordinates

Methods inherited from class gda.device.scannable.scannablegroup.ScannableGroupNamed

addGroupMember, getGroupMembersNamesAsArray, setGroupMembersNames, setGroupMembersNamesWithArray

Methods inherited from class gda.device.scannable.scannablegroup.ScannableGroup

__getattr__, addGroupMember, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, extractPositionsFromObject, getExtraNames, getGroupMember, getGroupMemberNames, getGroupMembers, getGroupMembersAsArray, getInputNames, getOutputFormat, getPosition, getUnits, isBusy, isDemandAllScannablePositions, removeGroupMemberByIndex, removeGroupMemberByScannable, setDemandAllScannablePositions, setExtraNames, setGroupMembers, setGroupMembersWithArray, setGroupMembersWithList, setInputNames, stop, update, waitWhileBusy

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, 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, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.gda.component.model.api.Assembly

addActionRule, checkAssemblies, clearConfiguration, getAdapter, getAllDevices, getDevice, getSubAssemblies, isEnabled

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface uk.ac.gda.component.model.api.CoordinatesMove

asynchronousMoveToCoordinates, checkMovementValid, getCurrentCoordinates, getDefinedCoordinates, moveToCoordinates

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface uk.ac.gda.component.beamline.gonio.Diffractometer

getName

Methods inherited from interface gda.factory.Findable

setName

Methods inherited from interface uk.ac.gda.component.beamline.gonio.Gonio

getScannableOmega, getScannableTableX, getScannableTableY, getScannableTableZ, getScannableX, getScannableY, getScannableZ, setScannableOmega, setScannableTableX, setScannableTableY, setScannableTableZ, setScannableX, setScannableY, setScannableZ

Methods inherited from interface uk.ac.gda.component.beamline.gonio.GonioService

activate, getScannableName, moveOmega, moveTableX, moveTableY, moveTableZ, moveTo, moveX, moveY, moveZ, park, readAxis, readOmega, readTableX, readTableY, readTableZ, readX, readY, readZ, stop

Methods inherited from interface uk.ac.gda.component.model.api.IndexMove

asynchronousMoveToDefined, asynchronousMoveToIndex, getDefinedCoordinatesNames, isAt, isAtIndex, moveToDefined, moveToIndex

Methods inherited from interface uk.ac.gda.component.model.api.IndexPositioner

addDefinedCoordinates, isLockedToIndexPositions, setDefinedCoordinates, updateCoordinates

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.scannable.scannablegroup.IScannableGroup

addGroupMember, addGroupMember, getGroupMemberNames, getGroupMembers, getGroupMembersAsArray, getUnits, removeGroupMemberByIndex, removeGroupMemberByScannable, setGroupMembers, setGroupMembersWithArray, setGroupMembersWithList

Methods inherited from interface gda.device.scannable.scannablegroup.IScannableGroupNamed

addGroupMemberByName, getGroupMemberByName, getGroupMembersNames, getGroupMembersNamesAsArray, removeGroupMemberName, setGroupMembersNames, setGroupMembersNamesWithArray, setGroupMembersNamesWithArray, setGroupMembersNamesWithList

Methods inherited from interface gda.device.Scannable

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Constructor Details

DiffractometerBase

public DiffractometerBase()

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

Specified by:

configure in interface Diffractometer

Specified by:

configure in interface Gonio

Overrides:

configure in class GonioBase

Throws:

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

getScannableDetectorDistance

public String getScannableDetectorDistance()

Specified by:

getScannableDetectorDistance in interface Diffractometer

getScannableKappa

public String getScannableKappa()

Specified by:

getScannableKappa in interface Diffractometer

getScannableName

public String getScannableName(Diffractometer.DiffAxis axis)

Specified by:

getScannableName in interface Diffractometer

getScannablePhi

public String getScannablePhi()

Specified by:

getScannablePhi in interface Diffractometer

getScannableTwoTheta

public String getScannableTwoTheta()

Specified by:

getScannableTwoTheta in interface Diffractometer

moveDetectorDistance

public GonioService moveDetectorDistance(double distance)
                                  throws DeviceException

Specified by:

moveDetectorDistance in interface Diffractometer

Throws:

DeviceException

moveKappa

public GonioService moveKappa(double kappa)
                       throws DeviceException

Specified by:

moveKappa in interface Diffractometer

Throws:

DeviceException

movePhi

public GonioService movePhi(double phi)
                     throws DeviceException

Specified by:

movePhi in interface Diffractometer

Throws:

DeviceException

moveTwoTheta

public GonioService moveTwoTheta(double twotheta)
                          throws DeviceException

Specified by:

moveTwoTheta in interface Diffractometer

Throws:

DeviceException

readDetectorDistance

public Double readDetectorDistance()
                            throws DeviceException

Specified by:

readDetectorDistance in interface Diffractometer

Throws:

DeviceException

readKappa

public Double readKappa()
                 throws DeviceException

Specified by:

readKappa in interface Diffractometer

Throws:

DeviceException

readPhi

public Double readPhi()
               throws DeviceException

Specified by:

readPhi in interface Diffractometer

Throws:

DeviceException

readTwoTheta

public Double readTwoTheta()
                    throws DeviceException

Specified by:

readTwoTheta in interface Diffractometer

Throws:

DeviceException

setScannableDetectorDistance

public void setScannableDetectorDistance(String scannableDetectorDistance)

Specified by:

setScannableDetectorDistance in interface Diffractometer

setScannableKappa

public void setScannableKappa(String scannableKappa)

Specified by:

setScannableKappa in interface Diffractometer

setScannablePhi

public void setScannablePhi(String scannablePhi)

Specified by:

setScannablePhi in interface Diffractometer

setScannableTwoTheta

public void setScannableTwoTheta(String scannableTwoTheta)

Specified by:

setScannableTwoTheta in interface Diffractometer