|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.nc2.Dimension
public class Dimension
A Dimension is used to define the array shape of a Variable. It may be shared among Variables, which provides a simple yet powerful way of associating Variables. When a Dimension is shared, it has a unique name within its Group. It may have a coordinate Variable, which gives each index a coordinate value. A private Dimension cannot have a coordinate Variable, so use shared dimensions with coordinates when possible. The Dimension length must be > 0, except for an unlimited dimension which may have length = 0, and a vlen Dimension has length = -1.
Immutable if setImmutable() was called, except for an Unlimited Dimension, whose size can change.
Field Summary | |
---|---|
static Dimension |
VLEN
A variable-length dimension: the length is not known until the data is read. |
Constructor Summary | |
---|---|
Dimension(java.lang.String name,
Dimension from)
Copy Constructor. |
|
Dimension(java.lang.String name,
int length)
Constructor |
|
Dimension(java.lang.String name,
int length,
boolean isShared)
Constructor |
|
Dimension(java.lang.String name,
int length,
boolean isShared,
boolean isUnlimited,
boolean isVariableLength)
Constructor |
Method Summary | |
---|---|
void |
addCoordinateVariable(Variable v)
Deprecated. - do not use |
int |
compareTo(java.lang.Object o)
Dimensions with the same name are equal. |
boolean |
equals(java.lang.Object oo)
Instances which have same contents are equal. |
java.util.List<Variable> |
getCoordinateVariables()
Deprecated. - do not use |
Group |
getGroup()
Get the Group that owns this Dimension. |
int |
getLength()
Get the length of the Dimension. |
java.lang.String |
getName()
Returns the name of this Dimension; may be null. |
int |
hashCode()
Override Object.hashCode() to implement equals. |
boolean |
isShared()
If this Dimension is shared, or is private to a Variable. |
boolean |
isUnlimited()
If unlimited, then the length can increase; otherwise it is immutable. |
boolean |
isVariableLength()
If variable length, then the length is unknown until the data is read. |
void |
setGroup(Group g)
Set the group |
Dimension |
setImmutable()
Make this immutable. |
void |
setLength(int n)
Set the Dimension length. |
void |
setName(java.lang.String name)
rename |
void |
setShared(boolean b)
Set whether this is shared. |
void |
setUnlimited(boolean b)
Set whether this is unlimited, meaning length can increase. |
void |
setVariableLength(boolean b)
Set whether the length is variable. |
java.lang.String |
toString()
CDL representation, not strict. |
java.lang.String |
writeCDL(boolean strict)
CDL representation. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static Dimension VLEN
Constructor Detail |
---|
public Dimension(java.lang.String name, int length)
name
- name must be unique within grouplength
- length of Dimensionpublic Dimension(java.lang.String name, int length, boolean isShared)
name
- name must be unique within grouplength
- length, or UNLIMITED.length or UNKNOWN.lengthisShared
- whether its shared or local to Variable.public Dimension(java.lang.String name, int length, boolean isShared, boolean isUnlimited, boolean isVariableLength)
name
- name must be unique within group. Can be null only if not shared.length
- length, or UNLIMITED.length or UNKNOWN.lengthisShared
- whether its shared or local to Variable.isUnlimited
- whether the length can grow.isVariableLength
- whether the length is unknown until the data is read.public Dimension(java.lang.String name, Dimension from)
name
- name must be unique within group. Can be null only if not shared.from
- copy all other fields from here.Method Detail |
---|
public java.lang.String getName()
public int getLength()
public boolean isUnlimited()
public boolean isVariableLength()
public boolean isShared()
public Group getGroup()
public boolean equals(java.lang.Object oo)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
o
- compare to this Dimension
public java.lang.String writeCDL(boolean strict)
strict
- if true, write in strict adherence to CDL definition.
public void setUnlimited(boolean b)
b
- true if unlimitedpublic void setVariableLength(boolean b)
b
- true if variable lengthpublic void setShared(boolean b)
b
- true if sharedpublic void setLength(int n)
n
- length of Dimensionpublic void setName(java.lang.String name)
name
- new name of Dimension.public void setGroup(Group g)
g
- parent grouppublic Dimension setImmutable()
public void addCoordinateVariable(Variable v)
v
- coord varpublic java.util.List<Variable> getCoordinateVariables()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |