ucar.nc2.internal.grid

Class GridCS

java.lang.Object

ucar.nc2.internal.grid.GridCS

All Implemented Interfaces:

GridCoordinateSystem

@Immutable
public class GridCS
extends Object
implements GridCoordinateSystem

Implementation of GridCoordinateSystem.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
protected GridCS.Builder<?>	addLocalFieldsToBuilder(GridCS.Builder<? extends GridCS.Builder<?>> builder)
static GridCS.Builder<?>	builder()
boolean	equals(Object o)
Optional<GridAxis>	findAxis(String axisName) Find the named axis.
GridAxis	findCoordAxis(AxisType... axisType)
GridAxis1D	getEnsembleAxis() Get the ensemble axis.
FeatureType	getFeatureType()
com.google.common.collect.ImmutableList<GridAxis>	getGridAxes() the GridAxes that constitute this Coordinate System
GridHorizCoordinateSystem	getHorizCoordSystem() Get the Horizontal CoordinateSystem.
String	getName() The name of the Grid Coordinate System.
List<RangeIterator>	getRanges()
GridAxis1DTime	getRunTimeAxis() Get the Runtime axis.
GridAxis1DTime	getTimeAxis() Get the Time axis.
GridAxis	getTimeOffsetAxis() Get the Time Offset axis.
GridAxis1D	getVerticalAxis() Get the Z axis (GeoZ, Height, Pressure).
GridAxis	getXHorizAxis() Get the X axis.
GridAxis	getYHorizAxis() Get the Y axis.
int	hashCode()
void	show(Formatter f, boolean showCoords)
String	showFnSummary()
Optional<GridCoordinateSystem>	subset(GridSubset params, Formatter errlog) Subset each axis based on the given parameters.
GridCS.Builder<?>	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Description copied from interface: GridCoordinateSystem

The name of the Grid Coordinate System.

Specified by:

getName in interface GridCoordinateSystem

getFeatureType

public FeatureType getFeatureType()

getGridAxes

public com.google.common.collect.ImmutableList<GridAxis> getGridAxes()

Description copied from interface: GridCoordinateSystem

the GridAxes that constitute this Coordinate System

Specified by:

getGridAxes in interface GridCoordinateSystem

findAxis

public Optional<GridAxis> findAxis(String axisName)

Description copied from interface: GridCoordinateSystem

Find the named axis.

Specified by:

findAxis in interface GridCoordinateSystem

findCoordAxis

public GridAxis findCoordAxis(AxisType... axisType)

getEnsembleAxis

@Nullable
public GridAxis1D getEnsembleAxis()

Description copied from interface: GridCoordinateSystem

Get the ensemble axis.

Specified by:

getEnsembleAxis in interface GridCoordinateSystem

getXHorizAxis

public GridAxis getXHorizAxis()

Description copied from interface: GridCoordinateSystem

Get the X axis. (either GeoX or Lon)

Specified by:

getXHorizAxis in interface GridCoordinateSystem

getYHorizAxis

public GridAxis getYHorizAxis()

Description copied from interface: GridCoordinateSystem

Get the Y axis. (either GeoY or Lat)

Specified by:

getYHorizAxis in interface GridCoordinateSystem

getVerticalAxis

@Nullable
public GridAxis1D getVerticalAxis()

Description copied from interface: GridCoordinateSystem

Get the Z axis (GeoZ, Height, Pressure).

Specified by:

getVerticalAxis in interface GridCoordinateSystem

getTimeAxis

@Nullable
public GridAxis1DTime getTimeAxis()

Description copied from interface: GridCoordinateSystem

Get the Time axis.

Specified by:

getTimeAxis in interface GridCoordinateSystem

getRunTimeAxis

@Nullable
public GridAxis1DTime getRunTimeAxis()

Description copied from interface: GridCoordinateSystem

Get the Runtime axis.

Specified by:

getRunTimeAxis in interface GridCoordinateSystem

getTimeOffsetAxis

@Nullable
public GridAxis getTimeOffsetAxis()

Description copied from interface: GridCoordinateSystem

Get the Time Offset axis.

Specified by:

getTimeOffsetAxis in interface GridCoordinateSystem

getHorizCoordSystem

public GridHorizCoordinateSystem getHorizCoordSystem()

Description copied from interface: GridCoordinateSystem

Get the Horizontal CoordinateSystem.

Specified by:

getHorizCoordSystem in interface GridCoordinateSystem

toString

public String toString()

Overrides:

toString in class Object

show

public void show(Formatter f,
                 boolean showCoords)

Specified by:

show in interface GridCoordinateSystem

showFnSummary

public String showFnSummary()

Specified by:

showFnSummary in interface GridCoordinateSystem

getRanges

public List<RangeIterator> getRanges()

Specified by:

getRanges in interface GridCoordinateSystem

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

subset

public Optional<GridCoordinateSystem> subset(GridSubset params,
                                             Formatter errlog)

Description copied from interface: GridCoordinateSystem

Subset each axis based on the given parameters.

Specified by:

subset in interface GridCoordinateSystem

toBuilder

public GridCS.Builder<?> toBuilder()

addLocalFieldsToBuilder

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

builder

public static GridCS.Builder<?> builder()