ucar.nc2.iosp.gempak
Class GempakGridRecord

java.lang.Object
  extended by ucar.nc2.iosp.gempak.GempakGridRecord
All Implemented Interfaces:
GridRecord

public class GempakGridRecord
extends Object
implements GridRecord

A class to hold grid record information

Version:
$Revision: 1.3 $
Author:
IDV Development Team

Field Summary
 int gridNumber
          grid number
 int ivcord
          coordinate type
 int level1
          Level 1
 int level2
          Level 2
 NavigationBlock navBlock
          packing type
 int packingType
          packing type
 String param
          parameter
 String time1
          Time 1
 String time2
          Time 2
 
Constructor Summary
GempakGridRecord(int number, int[] header)
          Create a grid header from the integer bits
 
Method Summary
 int cdmVariableHash()
          A hash code to group records into a CDM variable
 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
 String getGridDefRecordId()
          Get the grid def record id
 int getGridNumber()
          Get the grid number
 double getLevel1()
          Get the first level of this GridRecord
 double getLevel2()
          Get the second level of this GridRecord
 int getLevelType1()
          Get the type for the first level of this GridRecord
 int getLevelType2()
          Get the type for the second level of this GridRecord
 String getParameterDescription()
          Get the parameter description
 String getParameterName()
          Get the parameter name
 Date getReferenceTime()
          Get the first reference time of this GridRecord
 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.
 Date getValidTime()
          Get the valid time for this grid.
 int getValidTimeOffset()
          Get valid time offset (minutes) of this GridRecord
 String toString()
          Get a String representation of this object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

time1

public String time1
Time 1


time2

public String time2
Time 2


level1

public int level1
Level 1


level2

public int level2
Level 2


ivcord

public int ivcord
coordinate type


param

public String param
parameter


gridNumber

public int gridNumber
grid number


packingType

public int packingType
packing type


navBlock

public NavigationBlock navBlock
packing type

Constructor Detail

GempakGridRecord

public GempakGridRecord(int number,
                        int[] header)
Create a grid header from the integer bits

Parameters:
number - grid number
header - integer bits
Method Detail

getLevel1

public double getLevel1()
Get the first level of this GridRecord

Specified by:
getLevel1 in interface GridRecord
Returns:
the first level value

getLevel2

public double getLevel2()
Get the second level of this GridRecord

Specified by:
getLevel2 in interface GridRecord
Returns:
the second level value

getLevelType1

public int getLevelType1()
Get the type for the first level of this GridRecord

Specified by:
getLevelType1 in interface GridRecord
Returns:
level type

getLevelType2

public int getLevelType2()
Get the type for the second level of this GridRecord

Specified by:
getLevelType2 in interface GridRecord
Returns:
level type

getReferenceTime

public Date getReferenceTime()
Get the first reference time of this GridRecord

Specified by:
getReferenceTime in interface GridRecord
Returns:
reference time

getValidTime

public Date getValidTime()
Get the valid time for this grid.

Specified by:
getValidTime in interface GridRecord
Returns:
valid time

getValidTimeOffset

public int getValidTimeOffset()
Get valid time offset (minutes) of this GridRecord

Returns:
time offset

getParameterName

public String getParameterName()
Get the parameter name

Specified by:
getParameterName in interface GridRecord
Returns:
parameter name

getParameterDescription

public String getParameterDescription()
Get the parameter description

Specified by:
getParameterDescription in interface GridRecord
Returns:
parameter description

getGridDefRecordId

public String getGridDefRecordId()
Get the grid def record id

Specified by:
getGridDefRecordId in interface GridRecord
Returns:
parameter name

getGridNumber

public int getGridNumber()
Get the grid number

Returns:
grid number

getDecimalScale

public int getDecimalScale()
Get the decimal scale

Specified by:
getDecimalScale in interface GridRecord
Returns:
decimal scale

getTimeUnit

public int getTimeUnit()
Description copied from interface: GridRecord
Get the time unit as a code, which should be Grib2 table 4.4.

Specified by:
getTimeUnit in interface GridRecord
Returns:
the time unit as a code

getTimeUdunitName

public String getTimeUdunitName()
Description copied from interface: GridRecord
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

Specified by:
getTimeUdunitName in interface GridRecord
Returns:
the time unit as a String

cdmVariableHash

public int cdmVariableHash()
Description copied from interface: GridRecord
A hash code to group records into a CDM variable

Specified by:
cdmVariableHash in interface GridRecord
Returns:
group hash code

cdmVariableName

public String cdmVariableName(GridTableLookup lookup,
                              boolean useLevel,
                              boolean useStat)
Description copied from interface: GridRecord
A unique name for the CDM variable, must be consistent with cdmVariableHash

Specified by:
cdmVariableName in interface GridRecord
Returns:
unique CDM variable name

toString

public String toString()
Get a String representation of this object

Overrides:
toString in class Object
Returns:
a String representation of this object


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