ucar.nc2.iosp
Class LayoutTiled

java.lang.Object
  extended by ucar.nc2.iosp.LayoutTiled
All Implemented Interfaces:
Layout

public class LayoutTiled
extends Object
implements Layout

For datasets where the data are stored in chunks. "Tiled" means that all chunks are assumed to be equal size. Chunks have an offset into the complete array. Chunks do not necessarily cover the array, missing data is possible.

Since:
Jan 9, 2008
Author:
caron

Nested Class Summary
static class LayoutTiled.DataChunk
           
static interface LayoutTiled.DataChunkIterator
           
 
Nested classes/interfaces inherited from interface ucar.nc2.iosp.Layout
Layout.Chunk
 
Constructor Summary
LayoutTiled(LayoutTiled.DataChunkIterator chunkIterator, int[] chunkSize, int elemSize, Section wantSection)
          Constructor.
 
Method Summary
 int getElemSize()
          Get size of each element in bytes.
 long getTotalNelems()
          Get total number of elements in the wanted subset.
 boolean hasNext()
          Is there more to do
 Layout.Chunk next()
          Get the next chunk
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LayoutTiled

public LayoutTiled(LayoutTiled.DataChunkIterator chunkIterator,
                   int[] chunkSize,
                   int elemSize,
                   Section wantSection)
            throws InvalidRangeException,
                   IOException
Constructor.

Parameters:
chunkIterator - iterator over all available data chunks
chunkSize - all chunks assumed to be the same size
elemSize - size of an element in bytes.
wantSection - the wanted section of data, contains a List of Range objects. Must be complete
Throws:
InvalidRangeException - if section invalid for this variable
IOException - on io error
Method Detail

getTotalNelems

public long getTotalNelems()
Description copied from interface: Layout
Get total number of elements in the wanted subset.

Specified by:
getTotalNelems in interface Layout
Returns:
total number of elements in the wanted subset.

getElemSize

public int getElemSize()
Description copied from interface: Layout
Get size of each element in bytes.

Specified by:
getElemSize in interface Layout
Returns:
size of each element in bytes.

hasNext

public boolean hasNext()
Description copied from interface: Layout
Is there more to do

Specified by:
hasNext in interface Layout
Returns:
true if theres more to do

next

public Layout.Chunk next()
                  throws IOException
Description copied from interface: Layout
Get the next chunk

Specified by:
next in interface Layout
Returns:
next chunk, or null if !hasNext()
Throws:
IOException - on i/o error

toString

public String toString()
Overrides:
toString in class Object


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.