Package gda.device.scannable.scannablegroup

Interface IScannableGroup

All Superinterfaces:

Configurable, Device, Findable, gda.observable.IObservable, Scannable

All Known Subinterfaces:

Assembly, Beamline, Diffractometer, EndStation, Gonio, IScannableGroupNamed, PlateLoader, SampleEnvironment

All Known Implementing Classes:

AbstractPlateLoader, AssemblyAdapter, AssemblyBase, CoordinatedScannableGroup, DeferredAndTrajectoryScannableGroup, DeferredScannableGroup, DetectorArm, Diffractometer, DiffractometerBase, EndStationBase, GonioBase, MiniKappaGoniometerScannableGroup, MotomanRobotScannableGroup, PlateLoaderAdapter, SampleStage, ScannableGroup, ScannableGroupNamed, ScannableGroupSinglePosition, SmarGonXyzScannableGroup, TpScannableGroup, XesSpectrometerCrystal

public interface IScannableGroup
extends Scannable

Distributed interface for the ScannableGroup which provides a logical group of scannables See IScannableGroupNamed for additional Finder/Findable name support

Field Summary

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Method Summary

Modifier and Type	Method	Description
void	addGroupMember(Scannable scannable)
void	addGroupMember(Scannable groupMember, boolean toConfigure)
String[]	getGroupMemberNames()
List<Scannable>	getGroupMembers()
Scannable[]	getGroupMembersAsArray()
default String[]	getUnits()
void	removeGroupMemberByIndex(int index)
void	removeGroupMemberByScannable(Scannable scannable)
void	setGroupMembers(List<Scannable> scannables)
void	setGroupMembersWithArray(Scannable[] scannables)
void	setGroupMembersWithList(List<Scannable> groupMembers, boolean toConfigure)

Methods inherited from interface gda.factory.Configurable

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

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

Method Details

getGroupMembersAsArray

Scannable[] getGroupMembersAsArray()
                            throws DeviceException

Throws:

DeviceException

getGroupMembers

List<Scannable> getGroupMembers()
                         throws DeviceException

Throws:

DeviceException

setGroupMembers

void setGroupMembers(List<Scannable> scannables)
              throws FactoryException

Throws:

FactoryException

setGroupMembersWithArray

void setGroupMembersWithArray(Scannable[] scannables)
                       throws FactoryException

Throws:

FactoryException

removeGroupMemberByScannable

void removeGroupMemberByScannable(Scannable scannable)
                           throws FactoryException

Throws:

FactoryException

removeGroupMemberByIndex

void removeGroupMemberByIndex(int index)
                       throws FactoryException

Throws:

FactoryException

addGroupMember

void addGroupMember(Scannable scannable)
             throws FactoryException

Throws:

FactoryException

addGroupMember

void addGroupMember(Scannable groupMember,
 boolean toConfigure)
             throws FactoryException

Throws:

FactoryException

setGroupMembersWithList

void setGroupMembersWithList(List<Scannable> groupMembers,
 boolean toConfigure)
                      throws FactoryException

Throws:

FactoryException

getUnits

default String[] getUnits()
                   throws DeviceException

Throws:

DeviceException

getGroupMemberNames

String[] getGroupMemberNames()

Returns:

the names of the members of this group