ucar.nc2.dataset.CoordTransBuilderIF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdm Show documentation
Show all versions of cdm Show documentation
The NetCDF-Java Library is a Java interface to NetCDF files,
as well as to many other types of scientific data formats.
The newest version!
/*
* Copyright 1998-2014 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package ucar.nc2.dataset;
import ucar.nc2.Variable;
import ucar.nc2.Dimension;
import java.util.Formatter;
/**
* 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
*/
public interface CoordTransBuilderIF {
/**
* Make a CoordinateTransform from a Coordinate Transform Variable.
* @param ds the containing dataset
* @param ctv the coordinate transform variable.
* @return CoordinateTransform
*/
public CoordinateTransform makeCoordinateTransform (NetcdfDataset ds, Variable ctv);
/**
* 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.
* @param ds the dataset
* @param timeDim the time dimension
* @param vCT the vertical coordinate transform
* @return ucar.unidata.geoloc.vertical.VerticalTransform math transform
*/
public ucar.unidata.geoloc.vertical.VerticalTransform makeMathTransform(NetcdfDataset ds, Dimension timeDim, VerticalCT vCT);
/**
* Get the Transform name. Typically this is matched on by an attribute in the dataset.
* @return name of the transform.
*/
public String getTransformName();
/**
* Get the Transform Type : Vertical or Projection
* @return type of trrasnform
*/
public TransformType getTransformType();
/***
* Pass in a Formatter where error messages can be appended.
* @param sb use this Formatter to record parse and error info
*/
public void setErrorBuffer( Formatter sb);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy