ucar.nc2.dataset.conv
Class M3IOConvention

java.lang.Object
  ucar.nc2.dataset.CoordSysBuilder
      ucar.nc2.dataset.conv.M3IOConvention

All Implemented Interfaces:

CoordSysBuilderIF

public class M3IOConvention
extends CoordSysBuilder

Models-3/EDSS Input/Output netcf format. The Models-3/EDSS Input/Output Applications Programming Interface (I/O API) is the standard data access library for both NCSC's EDSS project and EPA's Models-3.

Author:

caron

See Also:

http://www.baronams.com/products/ioapi/index.html

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordSysBuilder

CoordSysBuilder.VarProcess

Field Summary

Fields inherited from class ucar.nc2.dataset.CoordSysBuilder

conventionName, coordVarMap, debug, log, parseInfo, resourcesDir, showRejects, userAdvice, varList

Constructor Summary

M3IOConvention()

Method Summary

void	augmentDataset(NetcdfDataset ncd, CancelTask cancelTask) This is where subclasses make changes to the dataset, like adding new variables, attribuites, etc.
protected void	constructCoordAxes(NetcdfDataset ds)
protected AxisType	getAxisType(NetcdfDataset ds, VariableEnhanced ve) Identify what kind of AxisType the named variable is.
static boolean	isMine(NetcdfFile ncfile)
protected void	makeCoordinateTransforms(NetcdfDataset ds) Take all previously identified Coordinate Transforms and create a CoordinateTransform object by calling CoordTransBuilder.makeCoordinateTransform().

Methods inherited from class ucar.nc2.dataset.CoordSysBuilder

addCoordinateSystems, addCoordinateVariable, addUserAdvice, assignCoordinateTransforms, assignExplicitCoordinateSystems, buildCoordinateSystems, findCoordinateAxes, findCoordinateAxis, findCoordinateSystems, findCoordinateTransforms, findVarProcess, getConventionUsed, getParseInfo, getUseMaximalCoordSys, getUserAdvice, hasXY, isCoordinateAxisForVariable, makeCoordinateAxes, makeCoordinateSystems, makeCoordinateSystemsImplicit, makeCoordinateSystemsMaximal, makeCoordinateTransform, makeCoordinateTransformVariable, makeDummyTransformVariable, registerConvention, registerConvention, registerNcML, setConventionUsed, setUseMaximalCoordSys

Methods inherited from class java.lang.Object

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

Constructor Detail

M3IOConvention

public M3IOConvention()

Method Detail

isMine

public static boolean isMine(NetcdfFile ncfile)

Parameters:

ncfile - the NetcdfFile to test

Returns:

true if we think this is a M3IO file.

augmentDataset

public void augmentDataset(NetcdfDataset ncd,
                           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 CoordSysBuilder

Parameters:

ncd - modify this dataset

cancelTask - give user a chance to bail out

constructCoordAxes

protected void constructCoordAxes(NetcdfDataset ds)

getAxisType

protected AxisType getAxisType(NetcdfDataset ds,
                               VariableEnhanced ve)

Description copied from class: CoordSysBuilder

Identify what kind of AxisType the named variable is. Only called for variables already identified as Coordinate Axes. Default null - subclasses can override.

Overrides:

getAxisType in class CoordSysBuilder

Parameters:

ds - for this dataset

ve - a variable alreaddy identified as a Coodinate Axis

Returns:

AxisType or null if unknown.

makeCoordinateTransforms

protected void makeCoordinateTransforms(NetcdfDataset ds)

Description copied from class: CoordSysBuilder

Take all previously identified Coordinate Transforms and create a CoordinateTransform object by calling CoordTransBuilder.makeCoordinateTransform().

Overrides:

makeCoordinateTransforms in class CoordSysBuilder

Parameters:

ds - why