Grib2Pds (GRIB IOSP and Feature Collection 4.3.19 API)

java.lang.Object
- ucar.nc2.grib.grib2.Grib2Pds

```
@Immutable
public abstract class Grib2Pds
extends Object
```
Abstract superclass for GRIB2 PDS handling. Inner classes are specific to each template.

Since:

3/28/11

Author:

caron

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Grib2Pds.PdsEnsemble`
`static interface`	`Grib2Pds.PdsEnsembleDerived`
`static interface`	`Grib2Pds.PdsInterval`
`static interface`	`Grib2Pds.PdsPercentile`
`static interface`	`Grib2Pds.PdsProbability`
`static class`	`Grib2Pds.SatelliteBand`
`static class`	`Grib2Pds.TimeInterval`

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] input

protected int template

Fields
Modifier and Type	Field and Description
`protected byte[]`	`input`
`protected int`	`template`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Grib2Pds(byte[] input)
Constructs a Grib2PDSVariables object from a byte[].

Constructors
Modifier	Constructor and Description
`protected`	`Grib2Pds(byte[] input)` Constructs a Grib2PDSVariables object from a byte[].

Method Summary

Methods
Modifier and Type	Method and Description
`protected CalendarDate`	`calcTime(int startIndex)`
`static Grib2Pds`	`factory(int template, byte[] input)` Factory for Grib2Pds
`int`	`getBackProcessId()`
`float[]`	`getExtraCoordinates()`
`int`	`getExtraCoordinatesCount()` Number of coordinate values at end of template.
`int`	`getForecastTime()` Forecast time in units of getTimeUnit() (bytes 19-22) forecast time for points, should not be used for intervals
`int`	`getGenProcessId()` Forecast/Analysis generating process identifier (defined by originating centre).
`int`	`getGenProcessType()` Type of Generating Process (Code Table 4.3)
`int`	`getLevelScale()`
`int`	`getLevelType1()`
`int`	`getLevelType2()`
`double`	`getLevelValue1()`
`double`	`getLevelValue2()`
`int`	`getNumberEnsembleForecasts()`
`int`	`getOctet(int index)` Get the indexth byte in the PDS as an integer.
`int`	`getOctetSigned(int index)`
`int`	`getParameterCategory()` Parameter Category
`int`	`getParameterNumber()` Parameter Number
`int`	`getPercentileValue()`
`int`	`getPerturbationNumber()`
`int`	`getPerturbationType()`
`double`	`getProbabilityLowerLimit()`
`int`	`getProbabilityType()`
`double`	`getProbabilityUpperLimit()`
`int`	`getRawLength()`
`int`	`getStatisticalProcessType()`
`int`	`getTemplateNumber()` product Definition template, Table 4.0
`abstract int`	`getTimeUnit()`
`boolean`	`isEnsemble()`
`boolean`	`isEnsembleDerived()`
`boolean`	`isPercentile()`
`boolean`	`isProbability()`
`boolean`	`isSpatialInterval()`
`boolean`	`isTimeInterval()`
`void`	`show(Formatter f)`
`abstract int`	`templateLength()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - input
```
protected byte[] input
```
  - template
```
protected final int template
```
- Constructor Detail
  - Grib2Pds
```
protected Grib2Pds(byte[] input)
            throws IOException
```
    Constructs a Grib2PDSVariables object from a byte[].
    
    Parameters:
    input - PDS
    
    Throws:
    
    IOException - if raf contains no valid GRIB file
- Method Detail
  - factory
```
public static Grib2Pds factory(int template,
               byte[] input)
                        throws IOException
```
    Factory for Grib2Pds
    
    Parameters:
    template - pds template number
    input - raw bytes
    
    Returns:
    Grib2Pds or null on error
    
    Throws:
    
    IOException - on read error
  - getTimeUnit
```
public abstract int getTimeUnit()
```
  - templateLength
```
public abstract int templateLength()
```
  - getExtraCoordinatesCount
```
public int getExtraCoordinatesCount()
```
    Number of coordinate values at end of template.
    
    Returns:
    Coordinates number
  - getExtraCoordinates
```
public final float[] getExtraCoordinates()
```
  - getTemplateNumber
```
public final int getTemplateNumber()
```
    product Definition template, Table 4.0
    
    Returns:
    ProductDefinition
  - getParameterCategory
```
public final int getParameterCategory()
```
    Parameter Category
    
    Returns:
    parameterCategory as int
  - getParameterNumber
```
public final int getParameterNumber()
```
    Parameter Number
    
    Returns:
    ParameterNumber
  - getGenProcessType
```
public int getGenProcessType()
```
    Type of Generating Process (Code Table 4.3)
    
    Returns:
    Type of Generating Process
  - getLevelValue1
```
public double getLevelValue1()
```
  - getLevelScale
```
public int getLevelScale()
```
  - getLevelValue2
```
public double getLevelValue2()
```
  - getLevelType1
```
public int getLevelType1()
```
  - getLevelType2
```
public int getLevelType2()
```
  - getGenProcessId
```
public int getGenProcessId()
```
    Forecast/Analysis generating process identifier (defined by originating centre).
    For NCEP, apparently http://www.nco.ncep.noaa.gov/pmb/docs/on388/tablea.html as linked from here: http://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_temp4-0.shtml
    
    Returns:
    generating process id
  - getBackProcessId
```
public int getBackProcessId()
```
  - isTimeInterval
```
public boolean isTimeInterval()
```
  - isSpatialInterval
```
public boolean isSpatialInterval()
```
  - getStatisticalProcessType
```
public int getStatisticalProcessType()
```
  - getForecastTime
```
public int getForecastTime()
```
    Forecast time in units of getTimeUnit() (bytes 19-22) forecast time for points, should not be used for intervals
    
    Returns:
    Forecast time
  - isEnsemble
```
public boolean isEnsemble()
```
  - getPerturbationNumber
```
public int getPerturbationNumber()
```
  - getPerturbationType
```
public int getPerturbationType()
```
  - isEnsembleDerived
```
public boolean isEnsembleDerived()
```
  - getNumberEnsembleForecasts
```
public int getNumberEnsembleForecasts()
```
  - isProbability
```
public boolean isProbability()
```
  - getProbabilityLowerLimit
```
public double getProbabilityLowerLimit()
```
  - getProbabilityUpperLimit
```
public double getProbabilityUpperLimit()
```
  - getProbabilityType
```
public int getProbabilityType()
```
  - isPercentile
```
public boolean isPercentile()
```
  - getPercentileValue
```
public int getPercentileValue()
```
  - show
```
public void show(Formatter f)
```
  - getOctet
```
public final int getOctet(int index)
```
    Get the indexth byte in the PDS as an integer. THIS IS ONE BASED (not zero) to correspond with the manual
    
    Parameters:
    index - 1 based index
    
    Returns:
    input[index-1] & 0xff
  - getOctetSigned
```
public final int getOctetSigned(int index)
```
  - getRawLength
```
public final int getRawLength()
```
  - calcTime
```
protected CalendarDate calcTime(int startIndex)
```

Class Grib2Pds

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

input

template

Constructor Detail

Grib2Pds

Method Detail

factory

getTimeUnit

templateLength

getExtraCoordinatesCount

getExtraCoordinates

getTemplateNumber

getParameterCategory

getParameterNumber

getGenProcessType

getLevelValue1

getLevelScale

getLevelValue2

getLevelType1

getLevelType2

getGenProcessId

getBackProcessId

isTimeInterval

isSpatialInterval

getStatisticalProcessType

getForecastTime

isEnsemble

getPerturbationNumber

getPerturbationType

isEnsembleDerived

getNumberEnsembleForecasts

isProbability

getProbabilityLowerLimit

getProbabilityUpperLimit

getProbabilityType

isPercentile

getPercentileValue

show

getOctet

getOctetSigned

getRawLength

calcTime