CDMA plugin API  3.1.0
CDMA core library
org.gumtree.data.interfaces.IDimension Interface Reference

The IDimension interface is used to describe values of an axis of a data item's array. More...

Inherits IModelObject.

List of all members.

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

Detailed Description

The IDimension interface is used to describe values of an axis of a data item's array.

Note:
When developing a plug-in consider using the data format engine's implementation. You should redefine this interface implementation, only in case of very specific needs.

pluginAPI 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.

Author:
nxi

Member Function Documentation

Dimensions with the same name are equal.

Parameters:
ocompare to this Dimension
Returns:
0, 1, or -1

Instances which have same contents are equal.

Parameters:
ooObject
Returns:
true or false

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.

Returns:
IArray containing coordinates

Get the length of the Dimension.

Returns:
integer value

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.

Returns:
String object

Override Object.hashCode() to implement equals.

Returns:
integer value

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.

Returns:
true or false

If unlimited, then the length can increase; otherwise it is immutable.

Returns:
true or false

If variable length, then the length is unknown until the data is read.

Returns:
true or false

Set coordinates values for this dimension.

Parameters:
arraywith new coordinates

Set the Dimension length.

Parameters:
ninteger value

Rename the dimension.

Parameters:
nameString object

Set whether this is shared.

Parameters:
bboolean type

Set whether this is unlimited, meaning length can increase.

Parameters:
bboolean type

Set whether the length is variable.

Parameters:
bboolean type

String representation.

Returns:
String object

String representation.

Parameters:
strictboolean type
Returns:
String object

The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables