ucar.nc2.grid

Class GridAxis

java.lang.Object

ucar.nc2.grid.GridAxis

All Implemented Interfaces:

Iterable<Object>

Direct Known Subclasses:

GridAxis1D, GridAxis2D, GridAxisOffsetTimeRegular

@Immutable
public abstract class GridAxis
extends Object
implements Iterable<Object>

A Coordinate Axis for Grids.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridAxis.Builder<T extends GridAxis.Builder<T>>
static class	GridAxis.DependenceType The way that the Axis depends on other axes.
static class	GridAxis.Spacing The spacing of the coordinate values, used for 1D axes.

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeContainer	attributes
protected AxisType	axisType
protected GridAxis.DependenceType	dependenceType
protected com.google.common.collect.ImmutableList<String>	dependsOn
protected String	description
protected boolean	isSubset
protected String	name
protected double	resolution
protected GridAxis.Spacing	spacing
protected String	units

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridAxis(GridAxis.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
protected GridAxis.Builder<?>	addLocalFieldsToBuilder(GridAxis.Builder<? extends GridAxis.Builder<?>> builder)
AttributeContainer	attributes()
int	compareTo(GridAxis o)
boolean	equals(Object o)
AxisType	getAxisType()
abstract Array<Double>	getCoordBoundsAsArray()
abstract Array<Double>	getCoordsAsArray()
GridAxis.DependenceType	getDependenceType()
com.google.common.collect.ImmutableList<String>	getDependsOn()
String	getDescription()
String	getName()
abstract RangeIterator	getRangeIterator()
double	getResolution() When spacing.isRegular, same as increment, otherwise the spacing average or mode, used for information only.
GridAxis.Spacing	getSpacing()
String	getUnits()
int	hashCode()
boolean	isInterval() spacing.isInterval().
boolean	isRegular() spacing.isRegular().
boolean	isSubset()
abstract GridAxis	subset(GridSubset params, Formatter errlog) Create a subset of this axis based on the SubsetParams.
abstract Optional<GridAxis>	subsetDependent(GridAxis1D subsetIndAxis, Formatter errlog)
String	toString()
void	toString(Formatter f, Indent indent)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

name

protected final String name

units

protected final String units

description

protected final String description

axisType

protected final AxisType axisType

attributes

protected final AttributeContainer attributes

dependenceType

protected final GridAxis.DependenceType dependenceType

dependsOn

protected final com.google.common.collect.ImmutableList<String> dependsOn

spacing

protected final GridAxis.Spacing spacing

resolution

protected final double resolution

isSubset

protected final boolean isSubset

Constructor Detail

GridAxis

protected GridAxis(GridAxis.Builder<?> builder)

Method Detail

getCoordsAsArray

public abstract Array<Double> getCoordsAsArray()

getCoordBoundsAsArray

public abstract Array<Double> getCoordBoundsAsArray()

subset

@Nullable
public abstract GridAxis subset(GridSubset params,
                                           Formatter errlog)

Create a subset of this axis based on the SubsetParams.

subsetDependent

public abstract Optional<GridAxis> subsetDependent(GridAxis1D subsetIndAxis,
                                                   Formatter errlog)

getRangeIterator

public abstract RangeIterator getRangeIterator()

getName

public String getName()

getDescription

public String getDescription()

getUnits

public String getUnits()

getAxisType

public AxisType getAxisType()

attributes

public AttributeContainer attributes()

getSpacing

public GridAxis.Spacing getSpacing()

isRegular

public boolean isRegular()

spacing.isRegular().

isInterval

public boolean isInterval()

spacing.isInterval().

getResolution

public double getResolution()

When spacing.isRegular, same as increment, otherwise the spacing average or mode, used for information only.

getDependenceType

public GridAxis.DependenceType getDependenceType()

getDependsOn

public com.google.common.collect.ImmutableList<String> getDependsOn()

isSubset

public boolean isSubset()

compareTo

public int compareTo(GridAxis o)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(Formatter f,
                     Indent indent)

addLocalFieldsToBuilder

protected GridAxis.Builder<?> addLocalFieldsToBuilder(GridAxis.Builder<? extends GridAxis.Builder<?>> builder)