Package org.eclipse.scanning.api.points.models

Class AbstractPointsModel

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.points.models.AbstractPointsModel

All Implemented Interfaces:

INameable, IScanPathModel, IScanPointGeneratorModel

Direct Known Subclasses:

AbstractAxialStepModel, AbstractMapModel, AbstractMultiModel, AxialArrayModel, AxialPointsModel, JythonGeneratorModel, OneAxisPointRepeatedModel, StaticModel

public abstract class AbstractPointsModel
extends AbstractNameable
implements IScanPointGeneratorModel

Abstract base class for models using the ScanPointGenerator module, providing property change support for the convenience of subclasses. Models should correlate to a Generator or series of Generator from ScanPointGenerator, that are valid targets for CompoundGenerators. A Generator must be able to produce from a Model its Axes, Units (of length 1 or length number of axes), size and whether it should alternate in upper dimensions. Additionally, if the model is capable of acting continuously [the Generator has a prepare_bounds method] then the generator should pass this argument from the model to the CompoundGenerator that will wrap the Generator.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	HARDCODED_UNITS
protected final PropertyChangeSupport	pcs

Constructor Summary

Constructors

Constructor	Description
AbstractPointsModel()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Property change support
boolean	equals(Object obj)
List<String>	getScannableNames()	The names of the axes which will be scanned by this model.
String	getSummary()
List<String>	getUnits()
int	hashCode()
boolean	isAlternating()	This setting only makes sense when there is another model outside of this model within a CompoundModel: e.g.
boolean	isContinuous()	If true the scan is continuous if possible, i.e.
void	removePropertyChangeListener(PropertyChangeListener listener)	Property change support
void	setAlternating(boolean alternating)
void	setContinuous(boolean newValue)
void	setUnits(List<String> units)
static boolean	supportsAlternating(Class<? extends IScanPointGeneratorModel> model)
static boolean	supportsContinuous(Class<? extends IScanPointGeneratorModel> model)
static boolean	supportsRandomOffset(Class<? extends IScanPointGeneratorModel> model)
static boolean	supportsVertical(Class<? extends IScanPointGeneratorModel> model)
String	toString()
void	updateFromPropertiesMap(Map<String,Object> properties)

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Field Details

HARDCODED_UNITS

protected static final String HARDCODED_UNITS

See Also:

• Constant Field Values

pcs

protected final PropertyChangeSupport pcs

Constructor Details

AbstractPointsModel

public AbstractPointsModel()

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: IScanPathModel

Property change support

Specified by:

addPropertyChangeListener in interface IScanPathModel

Parameters:

listener -

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: IScanPathModel

Property change support

Specified by:

removePropertyChangeListener in interface IScanPathModel

Parameters:

listener -

getScannableNames

public List<String> getScannableNames()

Description copied from interface: IScanPathModel

The names of the axes which will be scanned by this model.

Specified by:

getScannableNames in interface IScanPathModel

Returns:

getSummary

public String getSummary()

isContinuous

public boolean isContinuous()

Description copied from interface: IScanPointGeneratorModel

If true the scan is continuous if possible, i.e. the motors continue to move while the detectors are exposed, if false the motors stop at each point for the detectors are exposed. For a scan to be continous, generally it must done by malcolm device, i.e. for a GDA point of view the scan contains exactly one runnable device and that must be a malcolm device. Additionally continuous scanning is only possible for certain path models, e.g. TwoAxisGridPointsModel, where even then the scan will only be continuous in the fast axis, and step in the slow axis, where the x-axis is the fast axis by default.

Specified by:

isContinuous in interface IScanPointGeneratorModel

Returns:

true if the scan should be continuous, false otherwise.

setContinuous

public void setContinuous(boolean newValue)

Specified by:

setContinuous in interface IScanPointGeneratorModel

getUnits

public List<String> getUnits()

Specified by:

getUnits in interface IScanPointGeneratorModel

setUnits

public void setUnits(List<String> units)

Specified by:

setUnits in interface IScanPointGeneratorModel

isAlternating

public boolean isAlternating()

Description copied from interface: IScanPointGeneratorModel

This setting only makes sense when there is another model outside of this model within a CompoundModel: e.g. a StepModel in Energy outside of a Spiral in x, y will run the points of the Spiral backwards every alternate step of Energy, preventing having to return to starting positions of that scan. In the special case of Grid shaped scans both axes of the scan alternate, so it runs: bottom left -> bottom right -> top right -> top left, top left -> top right...

Specified by:

isAlternating in interface IScanPointGeneratorModel

Returns:

true if the scan is a alternating, false otherwise

setAlternating

public void setAlternating(boolean alternating)

Specified by:

setAlternating in interface IScanPointGeneratorModel

updateFromPropertiesMap

public void updateFromPropertiesMap(Map<String,Object> properties)

Specified by:

updateFromPropertiesMap in interface IScanPointGeneratorModel

supportsAlternating

public static boolean supportsAlternating(Class<? extends IScanPointGeneratorModel> model)

supportsContinuous

public static boolean supportsContinuous(Class<? extends IScanPointGeneratorModel> model)

supportsRandomOffset

public static boolean supportsRandomOffset(Class<? extends IScanPointGeneratorModel> model)

supportsVertical

public static boolean supportsVertical(Class<? extends IScanPointGeneratorModel> model)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNameable

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractNameable

toString

public String toString()

Overrides:

toString in class AbstractNameable