|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.nc2.Variable
ucar.nc2.Structure
public class Structure
A Structure is a type of Variable that contains other Variables, like a struct in C. A Structure can be scalar or multidimensional.
A call to structure.read() will read all of the data in a Structure, including nested structures, and returns an Array of StructureData, with all of the data in memory. If there is a nested sequence, the sequence data may be read into memory all at once, ot it may be read in increments as the iteration proceeds.
Generally, the programmer can assume that the data in one Structure are stored together, so that it is efficient to read an entire Structure, and then access the Variable data through the Arrays in the StructureData.
Field Summary |
---|
Fields inherited from class ucar.nc2.Variable |
---|
defaultSizeToCache |
Constructor Summary | |
---|---|
Structure(NetcdfFile ncfile,
Group group,
Structure parent,
java.lang.String shortName)
|
Method Summary | |
---|---|
Variable |
addMemberVariable(Variable v)
Add a member variable |
void |
calcElementSize()
Force recalculation of size of one element of this structure - equals the sum of sizes of its members. |
Variable |
findVariable(java.lang.String shortName)
Find the Variable member with the specified (short) name. |
int |
getElementSize()
Get the size of one element of the Structure. |
java.lang.String |
getNameAndAttributes()
Get String with name and attributes. |
StructureDataIterator |
getStructureIterator()
Iterator over all the data in a Structure. |
StructureDataIterator |
getStructureIterator(int bufferSize)
Get an efficient iterator over all the data in the Structure. |
java.util.List<java.lang.String> |
getVariableNames()
Get the (short) names of the variables contained directly in this Structure. |
java.util.List<Variable> |
getVariables()
Get the variables contained directly in this Structure. |
boolean |
isCaching()
Caching is not allowed |
boolean |
isSubset()
Find if this was created from a subset() method. |
StructureMembers |
makeStructureMembers()
Create a StructureMembers object that describes this Structure. |
StructureData |
readStructure()
Use this when this is a scalar Structure. |
StructureData |
readStructure(int index)
Use this when this is a one dimensional array of Structures, or you are doing the index calculation yourself for a multidimension array. |
ArrayStructure |
readStructure(int start,
int count)
For rank 1 array of Structures, read count Structures and return the data as an ArrayStructure. |
boolean |
removeMemberVariable(Variable v)
Remove a Variable : uses the Variable name to find it. |
boolean |
replaceMemberVariable(Variable newVar)
Replace a Variable with another that has the same name : uses the variable name to find it. |
Structure |
select(java.util.List<java.lang.String> memberNames)
Create a subset of the Structure consisting only of the given member variables |
Structure |
select(java.lang.String varName)
Create a subset of the Structure consisting only of the one member variable |
void |
setCaching(boolean caching)
Caching is not allowed |
Variable |
setImmutable()
Make this immutable. |
void |
setMemberVariables(java.util.List<Variable> vars)
Set the list of member variables. |
void |
setParentGroup(Group group)
Set the parent group of this Structure, and all member variables. |
java.lang.String |
writeCDL(java.lang.String indent,
boolean useFullName,
boolean strict)
CDL representation of a Variable. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Structure(NetcdfFile ncfile, Group group, Structure parent, java.lang.String shortName)
Method Detail |
---|
public Structure select(java.util.List<java.lang.String> memberNames)
memberNames
- list of Variable names, already a member
public Structure select(java.lang.String varName)
varName
- name of member Variable
public boolean isSubset()
public boolean isCaching()
isCaching
in class Variable
public void setCaching(boolean caching)
setCaching
in class Variable
caching
- set if caching.public Variable addMemberVariable(Variable v)
v
- add this variable as a member of this structure
public void setMemberVariables(java.util.List<Variable> vars)
vars
- this is the list of member variablespublic boolean removeMemberVariable(Variable v)
v
- remove this variable as a member of this structure
public boolean replaceMemberVariable(Variable newVar)
newVar
- add this variable as a member of this structure
public void setParentGroup(Group group)
setParentGroup
in class Variable
group
- set to this valuepublic Variable setImmutable()
Variable
setImmutable
in class Variable
public java.util.List<Variable> getVariables()
public java.util.List<java.lang.String> getVariableNames()
public Variable findVariable(java.lang.String shortName)
shortName
- name of the member variable.
public StructureMembers makeStructureMembers()
public int getElementSize()
getElementSize
in interface VariableIF
getElementSize
in class Variable
public void calcElementSize()
public StructureData readStructure() throws java.io.IOException
java.io.IOException
- on read errorpublic StructureData readStructure(int index) throws java.io.IOException, InvalidRangeException
index
- index into 1D array
java.io.IOException
- on read error
InvalidRangeException
- if index out of rangepublic ArrayStructure readStructure(int start, int count) throws java.io.IOException, InvalidRangeException
start
- start at this indexcount
- return this many StructureData
java.io.IOException
- on read error
InvalidRangeException
- if start, count out of rangepublic StructureDataIterator getStructureIterator() throws java.io.IOException
StructureDataIterator ii = structVariable.getStructureIterator(); while (ii.hasNext()) { StructureData sdata = ii.next(); }
java.io.IOException
- on read errorgetStructureIterator(int bufferSize)
public StructureDataIterator getStructureIterator(int bufferSize) throws java.io.IOException
Example: StructureDataIterator ii = structVariable.getStructureIterator(100 * 1000); while (ii.hasNext()) { StructureData sdata = ii.next(); }
bufferSize
- size in bytes to buffer, set < 0 to use default size
java.io.IOException
- on read errorpublic java.lang.String getNameAndAttributes()
public java.lang.String writeCDL(java.lang.String indent, boolean useFullName, boolean strict)
Variable
writeCDL
in class Variable
indent
- start each line with this much spaceuseFullName
- use full name, else use short namestrict
- strictly comply with ncgen syntax
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |