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

Class ConsecutiveMultiModel

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.api.points.models.AbstractMultiModel<IScanPointGeneratorModel>

org.eclipse.scanning.api.points.models.ConsecutiveMultiModel

All Implemented Interfaces:

INameable, IScanPathModel, IScanPointGeneratorModel

Direct Known Subclasses:

InterpolatedMultiScanModel

public class ConsecutiveMultiModel
extends AbstractMultiModel<IScanPointGeneratorModel>

A model that runs multiple other modules consecutively. Each model must be in the same axes, with the same units for each axis. A Compounded model (any grid) is not a valid model to be run consecutively. If run continuously, the models validation additionally must ensure that every models final bound (0.5 steps beyond the final point) is within DIFF_LIMIT (1e-5) in each axis of the initial bound (0.5 steps before the first point) for all axes.

Field Summary

Fields inherited from class org.eclipse.scanning.api.points.models.AbstractPointsModel

HARDCODED_UNITS, pcs

Constructor Summary

Constructors

Constructor	Description
ConsecutiveMultiModel()

Method Summary

Modifier and Type	Method	Description
List<String>	getScannableNames()	The names of the axes which will be scanned by this model.
List<String>	getUnits()

Methods inherited from class org.eclipse.scanning.api.points.models.AbstractMultiModel

addModel, clear, equals, getFirstModel, getModels, hashCode, setModels, toString

Methods inherited from class org.eclipse.scanning.api.points.models.AbstractPointsModel

addPropertyChangeListener, getSummary, isAlternating, isContinuous, removePropertyChangeListener, setAlternating, setContinuous, setUnits, supportsAlternating, supportsContinuous, supportsRandomOffset, supportsVertical, updateFromPropertiesMap

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

Constructor Details

ConsecutiveMultiModel

public ConsecutiveMultiModel()

Method Details

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

Overrides:

getScannableNames in class AbstractPointsModel

Returns:

getUnits

public List<String> getUnits()

Specified by:

getUnits in interface IScanPointGeneratorModel

Overrides:

getUnits in class AbstractPointsModel