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

Class AxialCollatedStepModel

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.api.points.models.AbstractAxialStepModel

org.eclipse.scanning.api.points.models.AxialCollatedStepModel

All Implemented Interfaces:

INameable, IBoundsToFit, IScanPathModel, IScanPointGeneratorModel

public class AxialCollatedStepModel
extends AbstractAxialStepModel

A model for a scan along multiple axes with the same start and stop positions and step size. Previously CollatedStepModel

Field Summary

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

HARDCODED_UNITS, pcs

Fields inherited from interface org.eclipse.scanning.api.points.models.IBoundsToFit

PROPERTY_DEFAULT_BOUNDS_FIT, PROPERTY_NAME_BOUNDS_TO_FIT

Constructor Summary

Constructors

Constructor	Description
AxialCollatedStepModel()
AxialCollatedStepModel(double start, double stop, double step, String... names)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getName()	Name of the scannable
List<String>	getNames()
List<String>	getScannableNames()	The names of the axes which will be scanned by this model.
int	hashCode()
boolean	isBoundsToFit()
void	setBoundsToFit(boolean boundsToFit)
void	setNames(List<String> name)
void	setUnits(List<String> units)
String	toString()

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

description, getStart, getStep, getStop, setStart, setStep, setStop

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

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

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

setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scanning.api.points.models.IBoundsToFit

defaultBoundsToFit

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

setName

Constructor Details

AxialCollatedStepModel

public AxialCollatedStepModel()

AxialCollatedStepModel

public AxialCollatedStepModel(double start,
 double stop,
 double step,
 String... names)

Method Details

getNames

public List<String> getNames()

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:

getName

public String getName()

Description copied from interface: INameable

Name of the scannable

Specified by:

getName in interface INameable

Overrides:

getName in class AbstractNameable

Returns:

setNames

public void setNames(List<String> name)

setUnits

public void setUnits(List<String> units)

Specified by:

setUnits in interface IScanPointGeneratorModel

Overrides:

setUnits in class AbstractPointsModel

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAxialStepModel

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAxialStepModel

toString

public String toString()

Overrides:

toString in class AbstractAxialStepModel

isBoundsToFit

public boolean isBoundsToFit()

Specified by:

isBoundsToFit in interface IBoundsToFit

setBoundsToFit

public void setBoundsToFit(boolean boundsToFit)

Specified by:

setBoundsToFit in interface IBoundsToFit