ucar.nc2.iosp.grid

Interface GridRecord

All Known Implementing Classes:

GempakGridRecord, McIDASGridRecord

public interface GridRecord

An interface for one 2D gridded data record (used by GRIB, GEMPAK, McIDAS gridded data). A collection of these records comprise a CDM variable, usually adding time and optionally vertical, and ensemble dimensions.

Method Summary

Modifier and Type	Method and Description
int	cdmVariableHash() A hash code to group records into a CDM variable
java.lang.String	cdmVariableName(GridTableLookup lookup, boolean useLevel, boolean useStat) A unique name for the CDM variable, must be consistent with cdmVariableHash
int	getDecimalScale() Get the decimal scale of the values
java.lang.String	getGridDefRecordId() Get the grid def record id
double	getLevel1() Get the first vertical level of this GridRecord
double	getLevel2() Get the second vertical level of this GridRecord
int	getLevelType1() Get the vertical level type of this GridRecord
int	getLevelType2() Get the vertical level type of this GridRecord
java.lang.String	getParameterDescription() Get the parameter description
java.lang.String	getParameterName() Get the parameter name
java.util.Date	getReferenceTime() Get the first reference time of this GridRecord
java.lang.String	getTimeUdunitName() Get the time unit as a String.
int	getTimeUnit() Get the time unit as a code, which should be Grib2 table 4.4.
java.util.Date	getValidTime() Get the valid time for this GridRecord.

Method Detail

getLevel1

double getLevel1()

Get the first vertical level of this GridRecord

Returns:

the first vertical level value

getLevel2

double getLevel2()

Get the second vertical level of this GridRecord

Returns:

the second vertical level value

getLevelType1

int getLevelType1()

Get the vertical level type of this GridRecord

Returns:

vertical level type

getLevelType2

int getLevelType2()

Get the vertical level type of this GridRecord

Returns:

vertical level type

getReferenceTime

java.util.Date getReferenceTime()

Get the first reference time of this GridRecord

Returns:

reference time

getValidTime

java.util.Date getValidTime()

Get the valid time for this GridRecord.

Returns:

valid time

getParameterName

java.lang.String getParameterName()

Get the parameter name

Returns:

parameter name

getParameterDescription

java.lang.String getParameterDescription()

Get the parameter description

Returns:

parameter description

getGridDefRecordId

java.lang.String getGridDefRecordId()

Get the grid def record id

Returns:

parameter name

getDecimalScale

int getDecimalScale()

Get the decimal scale of the values

Returns:

decimal scale

getTimeUnit

int getTimeUnit()

Get the time unit as a code, which should be Grib2 table 4.4.

Returns:

the time unit as a code

getTimeUdunitName

java.lang.String getTimeUdunitName()

Get the time unit as a String. Must be able to create a udunit like: String udunit = timeUnit + " since " + refDate So this assumes that any conversion factor is applied to the value

Returns:

the time unit as a String

cdmVariableHash

int cdmVariableHash()

A hash code to group records into a CDM variable

Returns:

group hash code

cdmVariableName

java.lang.String cdmVariableName(GridTableLookup lookup,
                                 boolean useLevel,
                                 boolean useStat)

A unique name for the CDM variable, must be consistent with cdmVariableHash

Returns:

unique CDM variable name