ucar.nc2.dataset.conv
Class CF1Convention

java.lang.Object
  extended by ucar.nc2.dataset.CoordSysBuilder
      extended by ucar.nc2.dataset.conv.COARDSConvention
          extended by ucar.nc2.dataset.conv.CSMConvention
              extended by ucar.nc2.dataset.conv.CF1Convention
All Implemented Interfaces:
CoordSysBuilderIF

public class CF1Convention
extends CSMConvention

CF-1 Convention. see http://www.cgd.ucar.edu/cms/eaton/cf-metadata/index.html

"The CF conventions for climate and forecast metadata are designed to promote the processing and sharing of files created with the netCDF API. The conventions define metadata that provide a definitive description of what the data in each variable represents, and of the spatial and temporal properties of the data. This enables users of data from different sources to decide which quantities are comparable, and facilitates building applications with powerful extraction, regridding, and display capabilities."

Author:
caron

Nested Class Summary
 
Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordSysBuilder
CoordSysBuilder.ConventionNameOk, CoordSysBuilder.VarProcess
 
Field Summary
 
Fields inherited from class ucar.nc2.dataset.CoordSysBuilder
resourcesDir
 
Constructor Summary
CF1Convention()
           
 
Method Summary
 void augmentDataset(NetcdfDataset ds, CancelTask cancelTask)
          This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.
static java.lang.String getZisPositive(java.lang.String zaxisName, java.lang.String vertCoordUnits)
          Guess the value of ZisPositive based on z axis name and units
 
Methods inherited from class ucar.nc2.dataset.CoordSysBuilder
addCoordinateSystems, addUserAdvice, buildCoordinateSystems, factory, getConventionUsed, getParseInfo, getUseMaximalCoordSys, getUserAdvice, makeDummyTransformVariable, registerConvention, registerConvention, registerConvention, registerNcML, setConventionUsed, setUseMaximalCoordSys
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CF1Convention

public CF1Convention()
Method Detail

getZisPositive

public static java.lang.String getZisPositive(java.lang.String zaxisName,
                                              java.lang.String vertCoordUnits)
Guess the value of ZisPositive based on z axis name and units

Parameters:
zaxisName - z coordinate axis name
vertCoordUnits - z coordinate axis name
Returns:
CF.POSITIVE_UP or CF.POSITIVE_DOWN

augmentDataset

public void augmentDataset(NetcdfDataset ds,
                           CancelTask cancelTask)
Description copied from class: CoordSysBuilder
This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.

Specified by:
augmentDataset in interface CoordSysBuilderIF
Overrides:
augmentDataset in class CSMConvention
Parameters:
ds - modify this dataset
cancelTask - give user a chance to bail out