ucar.grib
Class GribGridRecord

java.lang.Object
  ucar.grib.GribGridRecord

All Implemented Interfaces:

GridRecord

public final class GribGridRecord
extends java.lang.Object
implements GridRecord

Represents index information for one record in the Grib file.

Field Summary

boolean	bmsExists bms (Bit mapped section) Exists of record.
int	category productType, discipline, category, paramNumber of record.
int	center center subCenter table of record.
int	decimalScale decimalScale for Grib1 data.
int	discipline productType, discipline, category, paramNumber of record.
int	ensembleNumber Ensemble number.
int	forecastTime forecastTime as int.
int	gdsKey gdsKey of record.
boolean	isEnsemble is this record an Ensemble
int	levelType1 levelType1, levelType2 of record.
int	levelType2 levelType1, levelType2 of record.
double	levelValue1 levelValue1, levelValue2 of record.
double	levelValue2 levelValue1, levelValue2 of record.
float	lowerLimit lowerLimit, upperLimit of Probability type
int	numberForecasts numberForecasts of Ensemble.
long	offset1 offset1 of record.
long	offset2 offset2 of record.
int	paramNumber productType, discipline, category, paramNumber of record.
GribPDSVariablesIF	pdsVars Represents the PDS section of a Grib Messaage.
int	productType productType, discipline, category, paramNumber of record.
java.util.Date	refTime refTime as Date.
int	startOfInterval if forecast time is an interval, this is the start of the interval
int	subCenter center subCenter table of record.
int	table center subCenter table of record.
int	timeUnit time unit of forecast time
int	type Type of ensemble or Probablity forecast
int	typeGenProcess typeGenProcess of record.
float	upperLimit lowerLimit, upperLimit of Probability type

Constructor Summary

GribGridRecord()
default constructor, used by GribReadIndex (binary indices)

GribGridRecord(java.util.Calendar calendar, int productType, int discipline, int category, int param, int typeGenProcess, int levelType1, float levelValue1, int levelType2, float levelValue2, java.util.Date refTime, int foreTime, int gdsKey, long offset1, long offset2, int decimalScale, boolean bmsExists, int center, int subCenter, int table)
constructor given all parameters native.

Method Summary

int	getDecimalScale() Get the decimal scale
int	getEnsembleNumber() if ensemble, ensemble member number
int	getEnsembleType() if ensemble, ensemble type
java.lang.String	getGridDefRecordId() Get the grid def record id
int	getGridDefRecordIdInt() 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
int	getNumberForecasts() total number of ensemble forecasts
java.lang.String	getParameterName() Get the parameter name
java.util.Date	getReferenceTime() Get the first reference time of this GridRecord
java.util.Date	getValidTime() Get the valid time for this grid.
int	getValidTimeOffset() Get valid time offset (minutes) of this GridRecord
boolean	isEnsemble() is this an ensemble type record
void	setValidTime(java.util.Date t) _more_
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pdsVars

public GribPDSVariablesIF pdsVars

Represents the PDS section of a Grib Messaage. Probably only set for Ensemble data

productType

public int productType

productType, discipline, category, paramNumber of record.

discipline

public int discipline

productType, discipline, category, paramNumber of record.

category

public int category

productType, discipline, category, paramNumber of record.

paramNumber

public int paramNumber

productType, discipline, category, paramNumber of record.

typeGenProcess

public int typeGenProcess

typeGenProcess of record.

levelType1

public int levelType1

levelType1, levelType2 of record.

levelType2

public int levelType2

levelType1, levelType2 of record.

levelValue1

public double levelValue1

levelValue1, levelValue2 of record.

levelValue2

public double levelValue2

levelValue1, levelValue2 of record.

gdsKey

public int gdsKey

gdsKey of record.

offset1

public long offset1

offset1 of record.

offset2

public long offset2

offset2 of record.

refTime

public java.util.Date refTime

refTime as Date.

forecastTime

public int forecastTime

forecastTime as int. if forecast time is an interval, it's the end of the interval

startOfInterval

public int startOfInterval

if forecast time is an interval, this is the start of the interval

timeUnit

public int timeUnit

time unit of forecast time

decimalScale

public int decimalScale

decimalScale for Grib1 data.

bmsExists

public boolean bmsExists

bms (Bit mapped section) Exists of record.

center

public int center

center subCenter table of record.

subCenter

public int subCenter

center subCenter table of record.

table

public int table

center subCenter table of record.

isEnsemble

public boolean isEnsemble

is this record an Ensemble

ensembleNumber

public int ensembleNumber

Ensemble number.

numberForecasts

public int numberForecasts

numberForecasts of Ensemble.

type

public int type

Type of ensemble or Probablity forecast

lowerLimit

public float lowerLimit

lowerLimit, upperLimit of Probability type

upperLimit

public float upperLimit

lowerLimit, upperLimit of Probability type

Constructor Detail

GribGridRecord

public GribGridRecord()

default constructor, used by GribReadIndex (binary indices)

GribGridRecord

public GribGridRecord(java.util.Calendar calendar,
                      int productType,
                      int discipline,
                      int category,
                      int param,
                      int typeGenProcess,
                      int levelType1,
                      float levelValue1,
                      int levelType2,
                      float levelValue2,
                      java.util.Date refTime,
                      int foreTime,
                      int gdsKey,
                      long offset1,
                      long offset2,
                      int decimalScale,
                      boolean bmsExists,
                      int center,
                      int subCenter,
                      int table)

constructor given all parameters native. used to write indices

Parameters:

productType -

discipline -

category -

param -

typeGenProcess -

levelType1 -

levelValue1 -

levelType2 -

levelValue2 -

refTime -

foreTime -

gdsKey -

offset1 -

offset2 -

decimalScale -

bmsExists - either true or false bit-map exists

center -

subCenter -

table -

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 java.util.Date getReferenceTime()

Get the first reference time of this GridRecord

Specified by:

getReferenceTime in interface GridRecord

Returns:

reference time

getValidTime

public java.util.Date getValidTime()

Get the valid time for this grid.

Specified by:

getValidTime in interface GridRecord

Returns:

valid time

setValidTime

public void setValidTime(java.util.Date t)

_more_

Parameters:

t - _more_

getValidTimeOffset

public int getValidTimeOffset()

Get valid time offset (minutes) of this GridRecord

Specified by:

getValidTimeOffset in interface GridRecord

Returns:

time offset

getParameterName

public java.lang.String getParameterName()

Get the parameter name

Specified by:

getParameterName in interface GridRecord

Returns:

parameter name

getGridDefRecordIdInt

public int getGridDefRecordIdInt()

Get the grid def record id

Returns:

parameter name

getGridDefRecordId

public java.lang.String getGridDefRecordId()

Description copied from interface: GridRecord

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

isEnsemble

public boolean isEnsemble()

is this an ensemble type record

Returns:

isEnsemble

getEnsembleType

public int getEnsembleType()

if ensemble, ensemble type

Returns:

type as int

getEnsembleNumber

public int getEnsembleNumber()

if ensemble, ensemble member number

Returns:

ensembleNumber

getNumberForecasts

public int getNumberForecasts()

total number of ensemble forecasts

Returns:

numberForecasts

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object