Package org.eclipse.scanning.api.points

Class AbstractGenerator<T extends IScanPathModel>

java.lang.Object

org.eclipse.scanning.api.points.AbstractGenerator<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<IPosition>, IModelProvider<T>, IPointGenerator<T>

Direct Known Subclasses:

AbstractScanPointGenerator

public abstract class AbstractGenerator<T extends IScanPathModel>
extends Object
implements IPointGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected T	model

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGenerator()
protected	AbstractGenerator(T model)

Method Summary

Modifier and Type	Method	Description
List<IPosition>	createPoints()	Relatively slow because all the points have to exist in memory.
boolean	equals(Object obj)
T	getModel()	The model for the generator.
int	hashCode()
String	toString()
protected abstract void	validateModel()

Methods inherited from class java.lang.Object

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

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

setModel, updateModel

Methods inherited from interface org.eclipse.scanning.api.points.IPointGenerator

getDimensionNames, getFirstPoint, getNames, getRank, getShape, iterator, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

model

protected T extends IScanPathModel model

Constructor Details

AbstractGenerator

protected AbstractGenerator(T model)

AbstractGenerator

protected AbstractGenerator()

Method Details

validateModel

protected abstract void validateModel()

getModel

public T getModel()

Description copied from interface: IPointGenerator

The model for the generator.

Specified by:

getModel in interface IModelProvider<T extends IScanPathModel>

Specified by:

getModel in interface IPointGenerator<T extends IScanPathModel>

Returns:

createPoints

public List<IPosition> createPoints()

Description copied from interface: IPointGenerator

Relatively slow because all the points have to exist in memory. Points are lightweight and it is normally ok to have them all in memory. However if it can be avoided for a given scan, the scan will start faster.

Specified by:

createPoints in interface IPointGenerator<T extends IScanPathModel>

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object