|
CDMA client API
3.1.0
CDMA core library
|
The IDimension interface is used to describe values of an axis of a data item's array. More...
Inherits IModelObject.
Public Member Functions | |
| String | getName () |
| int | getLength () |
| boolean | isUnlimited () |
| boolean | isVariableLength () |
| boolean | isShared () |
| IArray | getCoordinateVariable () |
| boolean | equals (Object oo) |
| int | hashCode () |
| String | toString () |
| int | compareTo (Object o) |
| String | writeCDL (boolean strict) |
| void | setUnlimited (boolean b) |
| void | setVariableLength (boolean b) |
| void | setShared (boolean b) |
| void | setLength (int n) |
| void | setName (String name) |
| void | setCoordinateVariable (IArray array) throws ShapeNotMatchException |
The IDimension interface is used to describe values of an axis of a data item's array.
A dimension is used to define the array axis values for a data item. The shape of an array can be due, for example, to a motor movement the dimension will describe its position along that axis. It may be shared among data items, which provides a simple yet powerful way of associating data items.
| int org.gumtree.data.interfaces.IDimension.compareTo | ( | Object | o | ) |
Dimensions with the same name are equal.
| o | compare to this Dimension |
| boolean org.gumtree.data.interfaces.IDimension.equals | ( | Object | oo | ) |
Instances which have same contents are equal.
| oo | Object |
Get the coordinate variables or coordinate variable aliases if the dimension has any, else return an empty list. A coordinate variable has this as its single dimension, and names this Dimensions's the coordinates. A coordinate variable alias is the same as a coordinate variable, but its name must match the dimension name. If numeric, coordinate axis must be strictly monotonically increasing or decreasing.
Get the length of the Dimension.
Returns the name of this Dimension; may be null. A Dimension with a null name is called "anonymous" and must be private. Dimension names are unique within a Group.
Override Object.hashCode() to implement equals.
| boolean org.gumtree.data.interfaces.IDimension.isShared | ( | ) |
If this Dimension is shared, or is private to a Variable. All Dimensions in NetcdfFile.getDimensions() or Group.getDimensions() are shared. Dimensions in the Variable.getDimensions() may be shared or private.
If unlimited, then the length can increase; otherwise it is immutable.
If variable length, then the length is unknown until the data is read.
| void org.gumtree.data.interfaces.IDimension.setCoordinateVariable | ( | IArray | array | ) | throws ShapeNotMatchException |
Set coordinates values for this dimension.
| array | with new coordinates |
| void org.gumtree.data.interfaces.IDimension.setLength | ( | int | n | ) |
Set the Dimension length.
| n | integer value |
| void org.gumtree.data.interfaces.IDimension.setName | ( | String | name | ) |
Rename the dimension.
| name | String object |
| void org.gumtree.data.interfaces.IDimension.setShared | ( | boolean | b | ) |
Set whether this is shared.
| b | boolean type |
| void org.gumtree.data.interfaces.IDimension.setUnlimited | ( | boolean | b | ) |
Set whether this is unlimited, meaning length can increase.
| b | boolean type |
| void org.gumtree.data.interfaces.IDimension.setVariableLength | ( | boolean | b | ) |
Set whether the length is variable.
| b | boolean type |
String representation.
| String org.gumtree.data.interfaces.IDimension.writeCDL | ( | boolean | strict | ) |
String representation.
| strict | boolean type |