ucar.nc2.grid

Class GridAxis1D

java.lang.Object

ucar.nc2.grid.GridAxis

ucar.nc2.grid.GridAxis1D

All Implemented Interfaces:

Iterable<Object>

Direct Known Subclasses:

GridAxis1DTime

@Immutable
public class GridAxis1D
extends GridAxis

A 1 dimensional GridAxis.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridAxis1D.Builder<T extends GridAxis1D.Builder<T>>

Nested classes/interfaces inherited from class ucar.nc2.grid.GridAxis

GridAxis.DependenceType, GridAxis.Spacing

Field Summary

Fields inherited from class ucar.nc2.grid.GridAxis

attributes, axisType, dependenceType, dependsOn, description, isSubset, name, resolution, spacing, units

Method Summary

Modifier and Type	Method and Description
protected GridAxis1D.Builder<?>	addLocalFieldsToBuilder(GridAxis1D.Builder<? extends GridAxis.Builder<?>> builder)
static GridAxis1D.Builder<?>	builder() Get Builder for this class that allows subclassing.
static GridAxis1D.Builder<?>	builder(VariableDS vds) A builder initializing its fields from a VariableDS
boolean	equals(Object o)
Array<Double>	getCoordBoundsAsArray()
double	getCoordEdge1(int index)
double	getCoordEdge2(int index)
MinMax	getCoordEdgeMinMax()
CoordInterval	getCoordInterval(int index)
double	getCoordMidpoint(int index)
Array<Double>	getCoordsAsArray()
double	getEndValue() Ending value when spacing.isRegular().
int	getNcoords() The number of coordinates.
Range	getRange()
RangeIterator	getRangeIterator()
double	getStartValue() Starting value when spacing.isRegular().
String	getSummary()
double[]	getValues()
int	hashCode()
boolean	isAscending()
Iterator<Object>	iterator() Iterates over coordinate values, either Double or CoordInterval.
GridAxis	subset(GridSubset params, Formatter errLog) Create a subset of this axis based on the SubsetParams.
Optional<GridAxis>	subsetDependent(GridAxis1D subsetIndAxis, Formatter errLog)
GridAxis1D.Builder<?>	toBuilder()
void	toString(Formatter f, Indent indent)

Methods inherited from class ucar.nc2.grid.GridAxis

addLocalFieldsToBuilder, attributes, compareTo, getAxisType, getDependenceType, getDependsOn, getDescription, getName, getResolution, getSpacing, getUnits, isInterval, isRegular, isSubset, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class GridAxis

hashCode

public int hashCode()

Overrides:

hashCode in class GridAxis

toString

public void toString(Formatter f,
                     Indent indent)

Overrides:

toString in class GridAxis

getSummary

public String getSummary()

isAscending

public boolean isAscending()

getCoordEdgeMinMax

public MinMax getCoordEdgeMinMax()

getCoordMidpoint

public double getCoordMidpoint(int index)

getCoordEdge1

public double getCoordEdge1(int index)

getCoordEdge2

public double getCoordEdge2(int index)

getCoordInterval

public CoordInterval getCoordInterval(int index)

getCoordsAsArray

public Array<Double> getCoordsAsArray()

Specified by:

getCoordsAsArray in class GridAxis

getCoordBoundsAsArray

public Array<Double> getCoordBoundsAsArray()

Specified by:

getCoordBoundsAsArray in class GridAxis

getNcoords

public int getNcoords()

The number of coordinates. Coord or Interval.

getStartValue

public double getStartValue()

Starting value when spacing.isRegular(). Coord or Interval.

getEndValue

public double getEndValue()

Ending value when spacing.isRegular(). Coord or Interval.

getValues

public double[] getValues()

iterator

public Iterator<Object> iterator()

Iterates over coordinate values, either Double or CoordInterval.

getRangeIterator

public RangeIterator getRangeIterator()

Specified by:

getRangeIterator in class GridAxis

getRange

public Range getRange()

subset

@Nullable
public GridAxis subset(GridSubset params,
                                  Formatter errLog)

Description copied from class: GridAxis

Create a subset of this axis based on the SubsetParams.

Specified by:

subset in class GridAxis

subsetDependent

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

Specified by:

subsetDependent in class GridAxis

toBuilder

public GridAxis1D.Builder<?> toBuilder()

addLocalFieldsToBuilder

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

builder

public static GridAxis1D.Builder<?> builder(VariableDS vds)

A builder initializing its fields from a VariableDS

builder

public static GridAxis1D.Builder<?> builder()

Get Builder for this class that allows subclassing.