Package uk.ac.gda.component.model.core

Class AssemblyBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPlateLoader, EndStationBase, GonioBase

public class AssemblyBase
extends ScannableGroupNamed
implements Assembly, Configurable

Implementation of IScannableGroupNamed which manages names 'lightweight', i.e. only keeping in step with groupMembers after configuration and less tightly coupled: Until configure() is called, Names are kept simply as a list, rather than using the Finder to add the Scannable After configuration

Field Summary

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
AssemblyBase()
AssemblyBase(String name)
AssemblyBase(String name, Scannable[] groupMembers)
AssemblyBase(String name, Scannable[] groupMembers, String[] groupMembersNames)
AssemblyBase(String name, String[] groupMembersNames)
AssemblyBase(String name, List<Scannable> groupMembers)
AssemblyBase(String name, List<Scannable> groupMembers, List<String> groupMemberNames)

Method Summary

Modifier and Type	Method	Description
void	addActionRule(Scannable scannable, ActionRule rule, Device... devices)
void	addDefinedCoordinates(int index, Coordinates coordinates)
void	addDefinedCoordinates(String name, int index, Coordinates coordinates)
void	addDevice(Device device)
void	addGroupMemberByName(String name)
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
void	asynchronousMoveToCoordinates(Coordinates c)	Trigger a move/operation and return immediately.
void	asynchronousMoveToDefined(String coordinates)	Trigger a move/operation to a pre-defined and indexed position and return immediately.
void	asynchronousMoveToIndex(int index)
boolean	checkActionRules(Scannable scannable, Coordinates coords)
boolean	checkAssemblies()
protected boolean	checkAssemblies(Set<Assembly> structure)
boolean	checkMovementValid(Coordinates start, Coordinates target)
void	clearConfiguration()
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.
protected Coordinates	convertPositionArrayToCoordinates(Object position)
void	dispose()
void	disposeSubAssemblies()
Assembly	getAdapter(Class<? extends Assembly> adapter)
List<Device>	getAllDevices()
Coordinates	getCurrentCoordinates()	Returns the current predefined coordinates holder.
Collection<Coordinates>	getDefinedCoordinates()
Set<String>	getDefinedCoordinatesNames()	Returns an array of the names of registered defined coordinates
Device	getDevice(String name)
Scannable	getGroupMemberByName(String name)
List<String>	getGroupMembersNames()
Set<Assembly>	getSubAssemblies()
boolean	isAt(String coordinatesToTest)	Tests if the coordinates are at (or if appropriate, close to) the values in coordinatesToTest.
boolean	isAt(Coordinates coord)
boolean	isAtIndex(int indexToTest)
boolean	isEnabled()
boolean	isLockedToIndexPositions()	Tests if the underlying positioner is expected to only allow movements to the indexed positions.
protected boolean	isScannable(Device d)
boolean	isScannableAt(Position posn)
protected boolean	isVisited()
void	moveToCoordinates(Coordinates c)	Trigger a move/operation and block until completion.
void	moveToDefined(String coordinatesName)	Trigger a move/operation and block until completion.
void	moveToIndex(int index)
protected void	raiseVeto(Position pos)
void	removeApprover(ActionApprover approver)
void	removeGroupMemberName(String name)
void	setDefinedCoordinates(List<Coordinates> coords)
void	setEnabled(boolean enabled)
void	setGroupMembersNamesWithArray(String[] scannableNames, boolean toConfigure)
void	setGroupMembersNamesWithList(List<String> scannableNames, boolean toConfigure)
protected Assembly	setVisited(boolean isVisited)
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status
String	toString()
Coordinates	updateCoordinates(Coordinates coord)

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, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

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

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

getGroupMembersNamesAsArray, setGroupMembersNames, setGroupMembersNamesWithArray

Methods inherited from interface gda.device.Scannable

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, waitWhileBusy

Constructor Details

AssemblyBase

public AssemblyBase()

AssemblyBase

public AssemblyBase(String name,
 Scannable[] groupMembers)
             throws FactoryException

Throws:

FactoryException

AssemblyBase

public AssemblyBase(String name,
 List<Scannable> groupMembers)
             throws FactoryException

Throws:

FactoryException

AssemblyBase

public AssemblyBase(String name,
 List<Scannable> groupMembers,
 List<String> groupMemberNames)
             throws FactoryException

Throws:

FactoryException

AssemblyBase

public AssemblyBase(String name)

AssemblyBase

public AssemblyBase(String name,
 String[] groupMembersNames)
             throws FactoryException

Throws:

FactoryException

AssemblyBase

public AssemblyBase(String name,
 Scannable[] groupMembers,
 String[] groupMembersNames)
             throws FactoryException

Throws:

FactoryException

Method Details

addActionRule

public void addActionRule(Scannable scannable,
 ActionRule rule,
 Device... devices)
                   throws DeviceException

Specified by:

addActionRule in interface Assembly

Throws:

DeviceException

addDefinedCoordinates

public void addDefinedCoordinates(int index,
 Coordinates coordinates)
                           throws DeviceException

Throws:

DeviceException

addDefinedCoordinates

public void addDefinedCoordinates(String name,
 int index,
 Coordinates coordinates)
                           throws DeviceException

Specified by:

addDefinedCoordinates in interface IndexPositioner

Throws:

DeviceException

addDevice

public void addDevice(Device device)

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed. Converts the external (user) position to an internal position and passes this to rawAsynchronousMoveTo.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class ScannableGroup

Parameters:

position - Position to move to should have an element for each input field.

Throws:

DeviceException

asynchronousMoveToCoordinates

public void asynchronousMoveToCoordinates(Coordinates c)
                                   throws DeviceException

Description copied from interface: CoordinatesMove

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed.

Specified by:

asynchronousMoveToCoordinates in interface CoordinatesMove

Parameters:

c - Coordinates to move to

Throws:

DeviceException

asynchronousMoveToDefined

public void asynchronousMoveToDefined(String coordinates)
                               throws DeviceException

Description copied from interface: IndexMove

Trigger a move/operation to a pre-defined and indexed position and return immediately. Implementations of this method should be non-blocking to allow concurrent motion;

Specified by:

asynchronousMoveToDefined in interface IndexMove

Parameters:

coordinates - Coordinates to move to

Throws:

DeviceException

asynchronousMoveToIndex

public void asynchronousMoveToIndex(int index)
                             throws DeviceException

Specified by:

asynchronousMoveToIndex in interface IndexMove

Throws:

DeviceException

checkActionRules

public boolean checkActionRules(Scannable scannable,
 Coordinates coords)
                         throws DeviceException

Throws:

DeviceException

checkAssemblies

public boolean checkAssemblies()

Specified by:

checkAssemblies in interface Assembly

checkAssemblies

protected boolean checkAssemblies(Set<Assembly> structure)

checkMovementValid

public boolean checkMovementValid(Coordinates start,
 Coordinates target)

Specified by:

checkMovementValid in interface CoordinatesMove

clearConfiguration

public void clearConfiguration()
                        throws DeviceException,
FactoryException

Specified by:

clearConfiguration in interface Assembly

Throws:

DeviceException

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

Overrides:

configure in class ScannableGroup

Throws:

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

convertPositionArrayToCoordinates

protected Coordinates convertPositionArrayToCoordinates(Object position)

dispose

public void dispose()

disposeSubAssemblies

public void disposeSubAssemblies()

getAdapter

public Assembly getAdapter(Class<? extends Assembly> adapter)

Specified by:

getAdapter in interface Assembly

getAllDevices

public List<Device> getAllDevices()

Specified by:

getAllDevices in interface Assembly

getCurrentCoordinates

public Coordinates getCurrentCoordinates()
                                  throws DeviceException

Description copied from interface: CoordinatesMove

Returns the current predefined coordinates holder.

Specified by:

getCurrentCoordinates in interface CoordinatesMove

Returns:

Current Coordinate object with a position element for each scannable dimension.

Throws:

DeviceException

getDefinedCoordinates

public Collection<Coordinates> getDefinedCoordinates()

Specified by:

getDefinedCoordinates in interface CoordinatesMove

getDefinedCoordinatesNames

public Set<String> getDefinedCoordinatesNames()

Description copied from interface: IndexMove

Returns an array of the names of registered defined coordinates

Specified by:

getDefinedCoordinatesNames in interface IndexMove

Returns:

an array of defined coordinates names

getDevice

public Device getDevice(String name)
                 throws DeviceException

Specified by:

getDevice in interface Assembly

Throws:

DeviceException

getSubAssemblies

public Set<Assembly> getSubAssemblies()

Specified by:

getSubAssemblies in interface Assembly

isAt

public boolean isAt(Coordinates coord)
             throws DeviceException

Throws:

DeviceException

isAt

public boolean isAt(String coordinatesToTest)
             throws DeviceException

Description copied from interface: IndexMove

Tests if the coordinates are at (or if appropriate, close to) the values in coordinatesToTest.

Specified by:

isAt in interface IndexMove

Parameters:

coordinatesToTest - The position to compare the positioner's position to.

Returns:

true if coordinates is at coordinatesToTest

Throws:

DeviceException

isAtIndex

public boolean isAtIndex(int indexToTest)
                  throws DeviceException

Specified by:

isAtIndex in interface IndexMove

Throws:

DeviceException

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Assembly

isLockedToIndexPositions

public boolean isLockedToIndexPositions()

Description copied from interface: IndexPositioner

Tests if the underlying positioner is expected to only allow movements to the indexed positions.

Specified by:

isLockedToIndexPositions in interface IndexPositioner

Returns:

true if implementer is locked to indexed positions only

isScannable

protected boolean isScannable(Device d)

isScannableAt

public boolean isScannableAt(Position posn)
                      throws DeviceException

Throws:

DeviceException

isVisited

protected boolean isVisited()

moveToCoordinates

public void moveToCoordinates(Coordinates c)
                       throws DeviceException

Description copied from interface: CoordinatesMove

Trigger a move/operation and block until completion.

Specified by:

moveToCoordinates in interface CoordinatesMove

Throws:

DeviceException

moveToDefined

public void moveToDefined(String coordinatesName)
                   throws DeviceException

Description copied from interface: IndexMove

Trigger a move/operation and block until completion.

Specified by:

moveToDefined in interface IndexMove

Parameters:

coordinatesName - Coordinates to move to

Throws:

DeviceException

moveToIndex

public void moveToIndex(int index)
                 throws DeviceException

Specified by:

moveToIndex in interface IndexMove

Throws:

DeviceException

raiseVeto

protected void raiseVeto(Position pos)
                  throws DeviceException

Throws:

DeviceException

removeApprover

public void removeApprover(ActionApprover approver)

setDefinedCoordinates

public void setDefinedCoordinates(List<Coordinates> coords)
                           throws DeviceException

Specified by:

setDefinedCoordinates in interface IndexPositioner

Throws:

DeviceException

setEnabled

public void setEnabled(boolean enabled)

setVisited

protected Assembly setVisited(boolean isVisited)

toFormattedString

public String toFormattedString()

Description copied from interface: Scannable

Returns a string representation of the Scannable and its current position/value/status

Typically should return:

name : position

or for detectors, name : status

If the position/status cannot be determined, the function should return Scannable.VALUE_UNAVAILABLE in its place.

Specified by:

toFormattedString in interface Scannable

Overrides:

toFormattedString in class ScannableGroup

Returns:

string as defined above

updateCoordinates

public Coordinates updateCoordinates(Coordinates coord)
                              throws DeviceException

Specified by:

updateCoordinates in interface IndexPositioner

Throws:

DeviceException

getGroupMemberByName

public Scannable getGroupMemberByName(String name)
                               throws DeviceException

Specified by:

getGroupMemberByName in interface IScannableGroupNamed

Overrides:

getGroupMemberByName in class ScannableGroupNamed

Throws:

DeviceException

getGroupMembersNames

public List<String> getGroupMembersNames()

Specified by:

getGroupMembersNames in interface IScannableGroupNamed

Overrides:

getGroupMembersNames in class ScannableGroupNamed

setGroupMembersNamesWithList

public void setGroupMembersNamesWithList(List<String> scannableNames,
 boolean toConfigure)
                                  throws FactoryException

Specified by:

setGroupMembersNamesWithList in interface IScannableGroupNamed

Overrides:

setGroupMembersNamesWithList in class ScannableGroupNamed

Parameters:

scannableNames - - the names of the Scannables to add to the group

toConfigure - - Should this configure itself after setting the names? As Assemblies keep light-weight, this would perform the actual Finding of the Scannables as well as configure all the members

Throws:

FactoryException - if configuring a Scannable throws this Exception

setGroupMembersNamesWithArray

public void setGroupMembersNamesWithArray(String[] scannableNames,
 boolean toConfigure)
                                   throws FactoryException

Specified by:

setGroupMembersNamesWithArray in interface IScannableGroupNamed

Overrides:

setGroupMembersNamesWithArray in class ScannableGroupNamed

Parameters:

scannableNames - - the names of the Scannables to add to the group

toConfigure - - Should this configure itself after setting the names? As Assemblies keep light-weight, this would perform the actual Finding of the Scannables as well as configure all the members

Throws:

FactoryException - if configuring a Scannable throws this Exception

removeGroupMemberName

public void removeGroupMemberName(String name)
                           throws DeviceException

Specified by:

removeGroupMemberName in interface IScannableGroupNamed

Overrides:

removeGroupMemberName in class ScannableGroupNamed

Throws:

DeviceException

addGroupMemberByName

public void addGroupMemberByName(String name)
                          throws FactoryException

Specified by:

addGroupMemberByName in interface IScannableGroupNamed

Overrides:

addGroupMemberByName in class ScannableGroupNamed

Throws:

FactoryException

toString

public String toString()

Overrides:

toString in class ScannableGroup