ucar.grid
Interface GridTableLookup

All Known Implementing Classes:
GempakLookup, Grib1GridTableLookup, Grib2GridTableLookup, McIDASLookup, Vis5DIosp.Vis5DLookup

public interface GridTableLookup

Abstracts lookup functionality for subclasses of Grid IOSP


Field Summary
static int AlbersEqualArea
          Albers Equal Area
static int Curvilinear
          NCEP Curvilinear - needs 2D lat/lon
static int GaussianLatLon
          Gausian Lat/Lon
static int LambertAzimuthEqualArea
          Lambert Azimuth Equal Area
static int LambertConformal
          Lambert Conformal
static int Mercator
          Mercator
static int Orthographic
          Orthographic
static int PolarStereographic
          Polar Sterographic
static int RotatedLatLon
          Rotated Latitude Longitude
static int UTM
          Universal Transverse Mercator
 
Method Summary
 String getCategoryName(GridRecord gr)
          Get the grid category name
 String getComment()
          Comment for CF conventions
 String getDisciplineName(GridRecord gr)
          Get the grid discipline name
 Date getFirstBaseTime()
          Get the first base time
 float getFirstMissingValue()
          .
 String getGridName(GridDefRecord gds)
          Get the grid name
 String getGridType()
          Get the grid type (GRIB, GEMPAK, McIDAS, GRADS) for labelling
 String getInstitution()
          Institution for CF conventions
 String getLevelDescription(GridRecord gr)
          Get the level description
 String getLevelName(GridRecord gr)
          Get the level name
 String getLevelUnit(GridRecord gr)
          Get the level unit
 GridParameter getParameter(GridRecord gr)
          Get the grid parameter that corresponds to this record
 int getProjectionType(GridDefRecord gds)
          Get the projection type
 String getShapeName(GridDefRecord gds)
          Get the grid shape name
 String getSource()
          Generating Process of model for CF conventions
 String getTimeRangeUnitName(int tunit)
          Get the first time range unit name
 String getTitle()
          Title for CF conventions
 boolean isLatLon(GridDefRecord gds)
          Is this a lat/lon grid
 boolean isLayer(GridRecord gr)
          Check to see if this grid is a layer variable
 boolean isPositiveUp(GridRecord gr)
          Is postitive up for the vertical coordinate
 boolean isVerticalCoordinate(GridRecord gr)
          If vertical level should be made into a coordinate; dont do for surface, or levels without a meaningful coordinate value
 

Field Detail

PolarStereographic

static final int PolarStereographic
Polar Sterographic

See Also:
Constant Field Values

LambertConformal

static final int LambertConformal
Lambert Conformal

See Also:
Constant Field Values

Mercator

static final int Mercator
Mercator

See Also:
Constant Field Values

UTM

static final int UTM
Universal Transverse Mercator

See Also:
Constant Field Values

AlbersEqualArea

static final int AlbersEqualArea
Albers Equal Area

See Also:
Constant Field Values

LambertAzimuthEqualArea

static final int LambertAzimuthEqualArea
Lambert Azimuth Equal Area

See Also:
Constant Field Values

Orthographic

static final int Orthographic
Orthographic

See Also:
Constant Field Values

GaussianLatLon

static final int GaussianLatLon
Gausian Lat/Lon

See Also:
Constant Field Values

RotatedLatLon

static final int RotatedLatLon
Rotated Latitude Longitude

See Also:
Constant Field Values

Curvilinear

static final int Curvilinear
NCEP Curvilinear - needs 2D lat/lon

See Also:
Constant Field Values
Method Detail

getGridName

String getGridName(GridDefRecord gds)
Get the grid name

Parameters:
gds - Grid definition record
Returns:
GridName.

getShapeName

String getShapeName(GridDefRecord gds)
Get the grid shape name

Parameters:
gds - Grid definition record
Returns:
ShapeName.

getDisciplineName

String getDisciplineName(GridRecord gr)
Get the grid discipline name

Parameters:
gr - record to check
Returns:
DisciplineName.

getCategoryName

String getCategoryName(GridRecord gr)
Get the grid category name

Parameters:
gr - record to check
Returns:
CategoryName.

getParameter

GridParameter getParameter(GridRecord gr)
Get the grid parameter that corresponds to this record

Parameters:
gr - record to check
Returns:
Parameter.

getLevelName

String getLevelName(GridRecord gr)
Get the level name

Parameters:
gr - record to check
Returns:
LevelName.

getLevelDescription

String getLevelDescription(GridRecord gr)
Get the level description

Parameters:
gr - record to check
Returns:
LevelDescription.

getLevelUnit

String getLevelUnit(GridRecord gr)
Get the level unit

Parameters:
gr - GridRecord with metadata
Returns:
LevelUnit.

getFirstBaseTime

Date getFirstBaseTime()
Get the first base time

Returns:
FirstBaseTime.

getTimeRangeUnitName

String getTimeRangeUnitName(int tunit)
Get the first time range unit name

Returns:
the first time range unit name

isLatLon

boolean isLatLon(GridDefRecord gds)
Is this a lat/lon grid

Parameters:
gds - Grid definition record
Returns:
is this a LatLon Grid

isVerticalCoordinate

boolean isVerticalCoordinate(GridRecord gr)
If vertical level should be made into a coordinate; dont do for surface, or levels without a meaningful coordinate value

Parameters:
gr - GridRecord with metadata
Returns:
is this a VerticalCoordinate

isPositiveUp

boolean isPositiveUp(GridRecord gr)
Is postitive up for the vertical coordinate

Parameters:
gr - GridRecord with metadata
Returns:
is this positive up level

getProjectionType

int getProjectionType(GridDefRecord gds)
Get the projection type

Parameters:
gds - Grid definition record
Returns:
one of the enumerated types

getFirstMissingValue

float getFirstMissingValue()
.

Returns:
FirstMissingValue.

isLayer

boolean isLayer(GridRecord gr)
Check to see if this grid is a layer variable

Parameters:
gr - record to check
Returns:
true if a layer

getTitle

String getTitle()
Title for CF conventions

Returns:
Title

getInstitution

String getInstitution()
Institution for CF conventions

Returns:
Institution

getSource

String getSource()
Generating Process of model for CF conventions

Returns:
source

getComment

String getComment()
Comment for CF conventions

Returns:
comment

getGridType

String getGridType()
Get the grid type (GRIB, GEMPAK, McIDAS, GRADS) for labelling

Returns:
the grid type


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.