|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.nc2.Variable
ucar.nc2.Structure
ucar.nc2.Sequence
public class Sequence
Sequence is a one-dimensional Structure with indeterminate length. The only data access is through getStructureIterator().
Field Summary |
---|
Fields inherited from class ucar.nc2.Variable |
---|
defaultSizeToCache |
Constructor Summary | |
---|---|
Sequence(NetcdfFile ncfile,
Group group,
Structure parent,
java.lang.String shortName)
|
Method Summary | |
---|---|
Array |
read()
UnsupportedOperation |
Array |
read(int[] origin,
int[] shape)
UnsupportedOperation |
Array |
read(java.util.List<Range> ranges)
UnsupportedOperation |
Array |
read(Section section)
UnsupportedOperation |
Array |
read(java.lang.String sectionSpec)
UnsupportedOperation |
StructureData |
readStructure()
UnsupportedOperation |
StructureData |
readStructure(int index)
UnsupportedOperation |
ArrayStructure |
readStructure(int start,
int count)
UnsupportedOperation |
Variable |
section(Section subsection)
UnsupportedOperation |
Variable |
slice(int dim,
int value)
UnsupportedOperation |
Methods inherited from class ucar.nc2.Structure |
---|
addMemberVariable, calcElementSize, findVariable, getElementSize, getNameAndAttributes, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, isSubset, makeStructureMembers, removeMemberVariable, replaceMemberVariable, select, select, setCaching, setImmutable, setMemberVariables, setParentGroup, writeCDL |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Sequence(NetcdfFile ncfile, Group group, Structure parent, java.lang.String shortName)
Method Detail |
---|
public Array read(int[] origin, int[] shape) throws java.io.IOException, InvalidRangeException
read
in interface VariableIF
read
in class Variable
origin
- int array specifying the starting index. If null, assume all zeroes.shape
- int array specifying the extents in each dimension.
This becomes the shape of the returned Array.
java.lang.UnsupportedOperationException
java.io.IOException
InvalidRangeException
public Array read(java.lang.String sectionSpec) throws java.io.IOException, InvalidRangeException
read
in interface VariableIF
read
in class Variable
sectionSpec
- specification string, eg "1:2,10,:,1:100:10". May optionally have ().
java.lang.UnsupportedOperationException
java.io.IOException
InvalidRangeException
for sectionSpec syntax
public Array read(java.util.List<Range> ranges) throws java.io.IOException, InvalidRangeException
read
in class Variable
ranges
- list of Range specifying the section of data to read.
java.lang.UnsupportedOperationException
java.io.IOException
- if error
InvalidRangeException
- if ranges is invalidVariable.read(Section)
public Array read(Section section) throws java.io.IOException, InvalidRangeException
read
in interface VariableIF
read
in class Variable
section
- list of Range specifying the section of data to read.
Must be null or same rank as variable.
If list is null, assume all data.
Each Range corresponds to a Dimension. If the Range object is null, it means use the entire dimension.
java.lang.UnsupportedOperationException
java.io.IOException
- if error
InvalidRangeException
- if section is invalidpublic Array read() throws java.io.IOException
read
in interface VariableIF
read
in class Variable
java.lang.UnsupportedOperationException
java.io.IOException
public StructureData readStructure() throws java.io.IOException
readStructure
in class Structure
java.lang.UnsupportedOperationException
java.io.IOException
- on read errorpublic StructureData readStructure(int index) throws java.io.IOException, InvalidRangeException
readStructure
in class Structure
index
- index into 1D array
java.lang.UnsupportedOperationException
java.io.IOException
- on read error
InvalidRangeException
- if index out of rangepublic ArrayStructure readStructure(int start, int count) throws java.io.IOException, InvalidRangeException
readStructure
in class Structure
start
- start at this indexcount
- return this many StructureData
java.lang.UnsupportedOperationException
java.io.IOException
- on read error
InvalidRangeException
- if start, count out of rangepublic Variable slice(int dim, int value) throws InvalidRangeException
slice
in class Variable
dim
- which dimension to fixvalue
- at what index value
java.lang.UnsupportedOperationException
InvalidRangeException
- if dimension or value is illegalpublic Variable section(Section subsection) throws InvalidRangeException
section
in class Variable
subsection
- Section of this variable.
Each Range in the section corresponds to a Dimension, and specifies the section of data to read in that Dimension.
A Range object may be null, which means use the entire dimension.
java.lang.UnsupportedOperationException
InvalidRangeException
- if section not compatible with shape
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |