ucar.nc2.dataset

Interface CoordTransBuilderIF

All Known Implementing Classes:

AbstractCoordTransBuilder, AlbersEqualArea, AzimuthalEquidistant, FlatEarth, LambertAzimuthal, LambertConformalConic, LambertCylindricalEqualArea, Mercator, MSGnavigation, Orthographic, PolarStereographic, PolyconicProjection, RotatedLatLon, RotatedPole, Sinusoidal, Stereographic, TransverseMercator, UTM, VAtmHybridHeight, VAtmHybridSigmaPressure, VAtmLnPressure, VAtmSigma, VerticalPerspective, VExplicitField, VOceanS, VOceanSG1, VOceanSG2, VOceanSigma, WRFEtaTransformBuilder

public interface CoordTransBuilderIF

Implement this interface to add a Coordinate Transform to a NetcdfDataset. Must be able to know how to build one from the info in a Coordinate Transform Variable.

Author:

john caron

Method Summary

Methods

Modifier and Type	Method and Description
String	getTransformName() Get the Transform name.
TransformType	getTransformType() Get the Transform Type : Vertical or Projection
CoordinateTransform	makeCoordinateTransform(NetcdfDataset ds, Variable ctv) Make a CoordinateTransform from a Coordinate Transform Variable.
VerticalTransform	makeMathTransform(NetcdfDataset ds, Dimension timeDim, VerticalCT vCT) Make a VerticalTransform.
void	setErrorBuffer(Formatter sb) Pass in a Formatter where error messages can be appended.

Method Detail

makeCoordinateTransform

CoordinateTransform makeCoordinateTransform(NetcdfDataset ds,
                                          Variable ctv)

Make a CoordinateTransform from a Coordinate Transform Variable.

Parameters:

ds - the containing dataset

ctv - the coordinate transform variable.

Returns:

CoordinateTransform

makeMathTransform

VerticalTransform makeMathTransform(NetcdfDataset ds,
                                  Dimension timeDim,
                                  VerticalCT vCT)

Make a VerticalTransform. Only implement if you are a TransformType.Vertical. We need to defer making the transform until we've identified the time coordinate dimension.

Parameters:

ds - the dataset

timeDim - the time dimension

vCT - the vertical coordinate transform

Returns:

ucar.unidata.geoloc.vertical.VerticalTransform math transform

getTransformName

String getTransformName()

Get the Transform name. Typically this is matched on by an attribute in the dataset.

Returns:

name of the transform.

getTransformType

TransformType getTransformType()

Get the Transform Type : Vertical or Projection

Returns:

type of trrasnform

setErrorBuffer

void setErrorBuffer(Formatter sb)

Pass in a Formatter where error messages can be appended.

Parameters:

sb - use this Formatter to record parse and error info