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

Class GonioBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DiffractometerBase

public class GonioBase
extends AssemblyBase
implements Gonio

Nested Class Summary

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

GonioService.Axis

Field Summary

Fields

Modifier and Type	Field	Description
protected int	INDEX_ACTIVE
protected int	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
GonioBase()

Method Summary

Modifier and Type	Method	Description
Gonio	activate()
protected void	conditionalAddScannable(Assembly assembly, String name)
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.
Assembly	getAssembly()
String	getScannableName(GonioService.Axis axis)
String	getScannableOmega()
String	getScannableTableX()
String	getScannableTableY()
String	getScannableTableZ()
String	getScannableX()
String	getScannableY()
String	getScannableZ()
Gonio	moveOmega(double omega)
Gonio	moveTableX(double x)
Gonio	moveTableY(double y)
Gonio	moveTableZ(double z)
GonioService	moveTo(String scannable, double target)
Gonio	moveX(double x)
Gonio	moveY(double y)
Gonio	moveZ(double z)
Gonio	park()
Double	readAxis(String axisName)
Double	readOmega()
Double	readTableX()
Double	readTableY()
Double	readTableZ()
Double	readX()
Double	readY()
Double	readZ()
void	reconfigure()	Re-initialisation of values and states.
void	setScannableOmega(String scannableOmega)
void	setScannableTableX(String scannableTableX)
void	setScannableTableY(String scannableTableY)
void	setScannableTableZ(String scannableTableZ)
void	setScannableX(String scannableX)
void	setScannableY(String scannableY)
void	setScannableZ(String scannableZ)

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

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 gda.factory.Findable

setName

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

getName

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

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

Field Details

INDEX_PARK

protected int INDEX_PARK

INDEX_ACTIVE

protected int INDEX_ACTIVE

Constructor Details

GonioBase

public GonioBase()

Method Details

activate

public Gonio activate()
               throws DeviceException

Specified by:

activate in interface GonioService

Throws:

DeviceException

conditionalAddScannable

protected void conditionalAddScannable(Assembly assembly,
 String name)
                                throws FactoryException

Throws:

FactoryException

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 Gonio

Overrides:

configure in class AssemblyBase

Throws:

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

getAssembly

public Assembly getAssembly()

getScannableName

public String getScannableName(GonioService.Axis axis)

Specified by:

getScannableName in interface GonioService

getScannableOmega

public String getScannableOmega()

Specified by:

getScannableOmega in interface Gonio

getScannableTableX

public String getScannableTableX()

Specified by:

getScannableTableX in interface Gonio

getScannableTableY

public String getScannableTableY()

Specified by:

getScannableTableY in interface Gonio

getScannableTableZ

public String getScannableTableZ()

Specified by:

getScannableTableZ in interface Gonio

getScannableX

public String getScannableX()

Specified by:

getScannableX in interface Gonio

getScannableY

public String getScannableY()

Specified by:

getScannableY in interface Gonio

getScannableZ

public String getScannableZ()

Specified by:

getScannableZ in interface Gonio

moveOmega

public Gonio moveOmega(double omega)
                throws DeviceException

Specified by:

moveOmega in interface GonioService

Throws:

DeviceException

moveTableX

public Gonio moveTableX(double x)
                 throws DeviceException

Specified by:

moveTableX in interface GonioService

Throws:

DeviceException

moveTableY

public Gonio moveTableY(double y)
                 throws DeviceException

Specified by:

moveTableY in interface GonioService

Throws:

DeviceException

moveTableZ

public Gonio moveTableZ(double z)
                 throws DeviceException

Specified by:

moveTableZ in interface GonioService

Throws:

DeviceException

moveTo

public GonioService moveTo(String scannable,
 double target)
                    throws DeviceException

Specified by:

moveTo in interface GonioService

Throws:

DeviceException

moveX

public Gonio moveX(double x)
            throws DeviceException

Specified by:

moveX in interface GonioService

Throws:

DeviceException

moveY

public Gonio moveY(double y)
            throws DeviceException

Specified by:

moveY in interface GonioService

Throws:

DeviceException

moveZ

public Gonio moveZ(double z)
            throws DeviceException

Specified by:

moveZ in interface GonioService

Throws:

DeviceException

park

public Gonio park()
           throws DeviceException

Specified by:

park in interface GonioService

Throws:

DeviceException

readAxis

public Double readAxis(String axisName)
                throws DeviceException

Specified by:

readAxis in interface GonioService

Throws:

DeviceException

readOmega

public Double readOmega()
                 throws DeviceException

Specified by:

readOmega in interface GonioService

Throws:

DeviceException

readTableX

public Double readTableX()
                  throws DeviceException

Specified by:

readTableX in interface GonioService

Throws:

DeviceException

readTableY

public Double readTableY()
                  throws DeviceException

Specified by:

readTableY in interface GonioService

Throws:

DeviceException

readTableZ

public Double readTableZ()
                  throws DeviceException

Specified by:

readTableZ in interface GonioService

Throws:

DeviceException

readX

public Double readX()
             throws DeviceException

Specified by:

readX in interface GonioService

Throws:

DeviceException

readY

public Double readY()
             throws DeviceException

Specified by:

readY in interface GonioService

Throws:

DeviceException

readZ

public Double readZ()
             throws DeviceException

Specified by:

readZ in interface GonioService

Throws:

DeviceException

reconfigure

public void reconfigure()
                 throws FactoryException

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

Throws:

FactoryException

setScannableOmega

public void setScannableOmega(String scannableOmega)

Specified by:

setScannableOmega in interface Gonio

setScannableTableX

public void setScannableTableX(String scannableTableX)

Specified by:

setScannableTableX in interface Gonio

setScannableTableY

public void setScannableTableY(String scannableTableY)

Specified by:

setScannableTableY in interface Gonio

setScannableTableZ

public void setScannableTableZ(String scannableTableZ)

Specified by:

setScannableTableZ in interface Gonio

setScannableX

public void setScannableX(String scannableX)

Specified by:

setScannableX in interface Gonio

setScannableY

public void setScannableY(String scannableY)

Specified by:

setScannableY in interface Gonio

setScannableZ

public void setScannableZ(String scannableZ)

Specified by:

setScannableZ in interface Gonio