Package ucar.nc2.dataset.transform

Interface VertTransformBuilderIF

All Known Implementing Classes:

CFHybridHeight, CFHybridSigmaPressure, CFLnPressure, CFOceanS, CFOceanSigma, CFSigma, CsmSigma, CsmSigma.HybridSigmaPressureBuilder, VExplicitField, VOceanSG1, VOceanSG2, WRFEtaTransformBuilder

public interface VertTransformBuilderIF

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.

Method Summary

Modifier and Type	Method	Description
String	getTransformName()	Get the Transform name.
VerticalCT	makeCoordinateTransform(NetcdfDataset ds, AttributeContainer ctv)	Make a vertical 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

VerticalCT makeCoordinateTransform(NetcdfDataset ds,
                                   AttributeContainer ctv)

Make a vertical CoordinateTransform from a Coordinate Transform Variable. A VerticalCT is just a container for the metadata, the real work is in the VerticalTransform

Parameters:

ds - the containing dataset

ctv - the coordinate transform variable.

Returns:

CoordinateTransform

makeMathTransform

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

Make a VerticalTransform. 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.

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