ucar.nc2.grib.grib1

Class Grib1ParamTime

java.lang.Object

ucar.nc2.grib.grib1.Grib1ParamTime

@Immutable
public class Grib1ParamTime
extends Object

Time coordinate from the PDS. Process information from GRIB-1 Table 4: "Forecast time unit" Process information from GRIB-1 Table 5: "Time range indicator"

Since:

9/4/11

Author:

John

Constructor Summary

Constructors

Constructor and Description
Grib1ParamTime(Grib1Customizer cust, Grib1SectionProductDefinition pds) Handles GRIB-1 code table 5 : "Time range indicator".

Method Summary

Methods

Modifier and Type	Method and Description
int	getForecastTime() Forecast time since reference time in units of timeUnit, only if not an interval.
int[]	getInterval() Get interval [start, end] since reference time in units of timeUnit, only if an interval.
int	getIntervalSize() Get interval size (end - start) in units of timeUnit, only if an interval.
GribStatType	getStatType() The time unit statistical type, derived from code table 5)
String	getTimeCoord() A string representation of the time coordinate, whether its an interval or not.
String	getTimeTypeName() The time unit name (code table 5)
boolean	isInterval() Is this an interval time coordinate

Methods inherited from class java.lang.Object

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

Constructor Detail

Grib1ParamTime

public Grib1ParamTime(Grib1Customizer cust,
              Grib1SectionProductDefinition pds)

Handles GRIB-1 code table 5 : "Time range indicator".

Parameters:

cust - customizer

pds - the Grib1SectionProductDefinition

Method Detail

getInterval

public int[] getInterval()

Get interval [start, end] since reference time in units of timeUnit, only if an interval.

Returns:

interval [start, end]

getIntervalSize

public int getIntervalSize()

Get interval size (end - start) in units of timeUnit, only if an interval.

Returns:

interval size

isInterval

public boolean isInterval()

Is this an interval time coordinate

Returns:

If an interval time coordinate

getForecastTime

public int getForecastTime()

Forecast time since reference time in units of timeUnit, only if not an interval.

Returns:

Forecast time

getTimeTypeName

public String getTimeTypeName()

The time unit name (code table 5)

Returns:

time unit name

getStatType

public GribStatType getStatType()

The time unit statistical type, derived from code table 5)

Returns:

time unit statistical type

getTimeCoord

public String getTimeCoord()

A string representation of the time coordinate, whether its an interval or not.

Returns:

string representation of the time coordinate