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

Class TwoAxisGridPointsModel

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.api.points.models.AbstractMapModel

org.eclipse.scanning.api.points.models.AbstractBoundingBoxModel

org.eclipse.scanning.api.points.models.AbstractTwoAxisGridModel

org.eclipse.scanning.api.points.models.TwoAxisGridPointsModel

All Implemented Interfaces:

INameable, IBoundingBoxModel, IBoundsToFit, IMapPathModel, IScanPathModel, IScanPointGeneratorModel

Direct Known Subclasses:

TwoAxisGridPointsRandomOffsetModel

public class TwoAxisGridPointsModel
extends AbstractTwoAxisGridModel

A model for a raster scan within a rectangular box in two-dimensional space, which evenly fills the box with a grid defined by the numbers of points (along each of the two axes) set in this model.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.scanning.api.points.models.AbstractTwoAxisGridModel

AbstractTwoAxisGridModel.Orientation

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
TwoAxisGridPointsModel()
TwoAxisGridPointsModel(String xName, String yName)
TwoAxisGridPointsModel(String xName, String yName, int xPoints, int yPoints)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getxAxisPoints()
int	getyAxisPoints()
int	hashCode()
void	setxAxisPoints(int newValue)
void	setyAxisPoints(int newValue)
String	toString()
void	updateFromPropertiesMap(Map<String,Object> properties)

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

enforceShape, getOrientation, isAlternateBothAxes, isBoundsToFit, isVerticalOrientation, setAlternateBothAxes, setBoundsToFit, setOrientation

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

getBoundingBox, setBoundingBox, setxAxisName, setyAxisName

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

getScannableNames, getUnits, getxAxisName, getxAxisUnits, getyAxisName, getyAxisUnits, setUnits, setxAxisUnits, setyAxisUnits

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

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

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.points.models.IBoundsToFit

defaultBoundsToFit

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

getxAxisName, getxAxisUnits, getyAxisName, getyAxisUnits, setxAxisUnits, setyAxisUnits

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

getName, setName

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

addPropertyChangeListener, getScannableNames, removePropertyChangeListener

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

getUnits, isAlternating, isContinuous, setAlternating, setContinuous, setUnits

Constructor Details

TwoAxisGridPointsModel

public TwoAxisGridPointsModel()

TwoAxisGridPointsModel

public TwoAxisGridPointsModel(String xName,
 String yName)

TwoAxisGridPointsModel

public TwoAxisGridPointsModel(String xName,
 String yName,
 int xPoints,
 int yPoints)

Method Details

getxAxisPoints

public int getxAxisPoints()

setxAxisPoints

public void setxAxisPoints(int newValue)

getyAxisPoints

public int getyAxisPoints()

setyAxisPoints

public void setyAxisPoints(int newValue)

updateFromPropertiesMap

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

Specified by:

updateFromPropertiesMap in interface IScanPointGeneratorModel

Overrides:

updateFromPropertiesMap in class AbstractTwoAxisGridModel

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTwoAxisGridModel

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractTwoAxisGridModel

toString

public String toString()

Overrides:

toString in class AbstractTwoAxisGridModel