API / geotoolkit3d / data / reservoir / hexahedral / voxel / CellIJKIterator / CellIJKIterator
voxel.CellIJKIterator.CellIJKIterator
Iterator to iterate over each cell IJK indices in a voxel grid. Because grid can contain million of cells, this iterator cannot fully implement geotoolkit/util/iterator
Constructors
- [new CellIJKIterator(iCount, jCount, kCount)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.data-8.reservoir-1.hexahedral.voxel.cellijkiterator.cellijkiterator.md#new cellijkiterator(icount, jcount, kcount))
Constructors
• new CellIJKIterator(iCount, jCount, kCount)
Constructor
| Name | Type | Description |
|---|---|---|
iCount | number | the grid size on the I axis. |
jCount | number | the grid size on the J axis. |
kCount | number | the grid size on the K axis. |
Methods
▸ getClassName(): string
string
▸ hasNext(): boolean
Returns true if the iterator has another cell to iterate on.
boolean
true if the iterator has another cell to iterate on.
▸ next(): CellIndices
Iterate over the next cell, and provide the cell indices. The absolute index is a unique index number allocated to each cell, start from 0 and goes up to sizeI * sizeJ * sizeK.<br> Please note this iterator might provide indices for cells with nullvalues/NaN values, please verify the value for the resulting cell.
the Cell IJK indices
▸ reset(): CellIJKIterator
Reset this iterator back to the first cell.
▸ Static getClassName(): string
string