Package org.eclipse.scanning.api.points
Interface ScanPointIterator
@Deprecated(since="GDA 9.17",
forRemoval=true)
public interface ScanPointIterator
extends Iterator<IPosition>
Deprecated, for removal: This API element is subject to removal in a future version.
-
Method Summary
Modifier and TypeMethodDescriptionintgetIndex()Deprecated, for removal: This API element is subject to removal in a future version.Returns index of the next position to be returned byIterator.next()intgetRank()Deprecated, for removal: This API element is subject to removal in a future version.Returns the rank of the points iterated over by this iterator.int[]getShape()Deprecated, for removal: This API element is subject to removal in a future version.Returns the shape of the points iterated over by this iterator.intgetSize()Deprecated, for removal: This API element is subject to removal in a future version.Returns the number of points iterated over by this iterator.Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove
-
Method Details
-
getSize
int getSize()Deprecated, for removal: This API element is subject to removal in a future version.Returns the number of points iterated over by this iterator.- Returns:
- size
-
getShape
int[] getShape()Deprecated, for removal: This API element is subject to removal in a future version.Returns the shape of the points iterated over by this iterator. In some cases dimensions may be flattened out, for example when the inner most scan is a grid scan within a circular region.- Returns:
- shape of scan
-
getRank
int getRank()Deprecated, for removal: This API element is subject to removal in a future version.Returns the rank of the points iterated over by this iterator. In some cases dimensions may be flattened out, for example when the inner most scan is a grid scan within a circular region.- Returns:
- rank of scan
-
getIndex
int getIndex()Deprecated, for removal: This API element is subject to removal in a future version.Returns index of the next position to be returned byIterator.next()- Returns:
-
IPositions that knows the size, shape and rank of the points it iterates over. Note: This class is an implementation class and should not be used outside the scanning framework. While mostAbstractGeneratorget Size/Shape/Rank information from their PPointGenerator, JythonGenerator currently still requires this information from the iterator. For PPointGenerators and generators that use them, the information is taken directly from the [Python] CompoundGenerator (see jython_spg_interface.py)