ucar.nc2.dataset.transform
Class VOceanSigma

java.lang.Object
  ucar.nc2.dataset.transform.AbstractCoordTransBuilder
      ucar.nc2.dataset.transform.VOceanSigma

All Implemented Interfaces:

CoordTransBuilderIF

public class VOceanSigma
extends AbstractCoordTransBuilder

Create a ocean_sigma_coordinate Vertical Transform from the information in the Coordinate Transform Variable.

Author:

caron

Field Summary

Fields inherited from class ucar.nc2.dataset.transform.AbstractCoordTransBuilder

errBuffer

Constructor Summary

VOceanSigma()

Method Summary

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.
String	toString()

Methods inherited from class ucar.nc2.dataset.transform.AbstractCoordTransBuilder

addParameter, getFalseEastingScaleFactor, getFormula, parseFormula, readAttributeDouble, readAttributeDouble2, setErrorBuffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VOceanSigma

public VOceanSigma()

Method Detail

getTransformName

public String getTransformName()

Description copied from interface: CoordTransBuilderIF

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

Returns:

name of the transform.

getTransformType

public TransformType getTransformType()

Description copied from interface: CoordTransBuilderIF

Get the Transform Type : Vertical or Projection

Returns:

type of trrasnform

makeCoordinateTransform

public CoordinateTransform makeCoordinateTransform(NetcdfDataset ds,
                                                   Variable ctv)

Description copied from interface: CoordTransBuilderIF

Make a CoordinateTransform from a Coordinate Transform Variable.

Parameters:

ds - the containing dataset

ctv - the coordinate transform variable.

Returns:

CoordinateTransform

toString

public String toString()

Overrides:

toString in class Object

makeMathTransform

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

Description copied from interface: CoordTransBuilderIF

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.

Specified by:

makeMathTransform in interface CoordTransBuilderIF

Overrides:

makeMathTransform in class AbstractCoordTransBuilder

Parameters:

ds - the dataset

timeDim - the time dimension

vCT - the vertical coordinate transform

Returns:

ucar.unidata.geoloc.vertical.VerticalTransform math transform