OdDataIterator (PLANitAllJavaOnly 0.4.0 API)

Type Parameters:

T - the type of data stored for each origin-destination cell

All Superinterfaces:

Iterator<T>

All Known Subinterfaces:

OdPathIterator

All Known Implementing Classes:

OdDemandMatrix.OdDemandMatrixIterator, OdHashedIterator, OdMatrixIterator, OdNonPrimitiveMatrixIterator, OdPathMatrix.OdPathMatrixIterator, OdPathsHashed.OdPathsHashedIterator, OdPrimitiveMatrixIterator, OdSkimMatrix.OdSkimMatrixIterator
```
public interface OdDataIterator<T>
extends Iterator<T>
```
Defines methods for an iterator which moves through a matrix of origin-destination cells

Author:

gman6028

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Zone`	`getCurrentDestination()`	Returns the destination zone object for the current cell
`Zone`	`getCurrentOrigin()`	Returns the origin zone object for the current cell
`T`	`getCurrentValue()`	Returns the value at the current cell

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove

- Method Detail
  - getCurrentOrigin
```
Zone getCurrentOrigin()
```
    Returns the origin zone object for the current cell
    
    Returns:
    
    the origin zone object at the current cell
  - getCurrentDestination
```
Zone getCurrentDestination()
```
    Returns the destination zone object for the current cell
    
    Returns:
    
    the destination zone object for the current cell
  - getCurrentValue
```
T getCurrentValue()
```
    Returns the value at the current cell
    
    Returns:
    
    the value at the current cell