Package noaa.coastwatch.util

Class LineLocationIterator

java.lang.Object

noaa.coastwatch.util.LineLocationIterator

All Implemented Interfaces:

Iterator<DataLocation>, DataLocationIterator, ResettableIterator

public class LineLocationIterator
extends Object
implements DataLocationIterator

The LineLocationIterator class iterates over data locations along a line between start and end locations. See LineIterator for details on how the locations are incremented along a line. Currently, only 2D data locations are supported.

Since:

3.1.7

Author:

Peter Hollemans

Constructor Summary

Constructors

Constructor	Description
LineLocationIterator(DataLocation start, DataLocation end)	Creates a new line location iterator.

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
static void	main(String[] argv)	Tests this class.
DataLocation	next()
DataLocation	nextLocation(DataLocation loc)	Gets the next data location.
void	remove()
void	reset()	Resets the iterator to the first element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

LineLocationIterator

public LineLocationIterator(DataLocation start,
 DataLocation end)

Creates a new line location iterator. The starting and ending locations are rounded to the nearest integer coordinates prior to deriving the line data locations.

Parameters:

start - the starting data location.

end - the ending data location.

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<DataLocation>

nextLocation

public DataLocation nextLocation(DataLocation loc)

Description copied from interface: DataLocationIterator

Gets the next data location.

Specified by:

nextLocation in interface DataLocationIterator

Parameters:

loc - the location to fill in with coordinates, or null to allocate a new location.

Returns:

the next location. The location is allocated only if the passed location is null, otherwise the same location is returned.

remove

public void remove()

Specified by:

remove in interface Iterator<DataLocation>

reset

public void reset()

Description copied from interface: ResettableIterator

Resets the iterator to the first element.

Specified by:

reset in interface ResettableIterator

next

public DataLocation next()

Specified by:

next in interface Iterator<DataLocation>

main

public static void main(String[] argv)

Tests this class.

Parameters:

argv - the array of command line parameters.