Grib1SectionProductDefinition (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

java.lang.Object
- ucar.nc2.grib.grib1.Grib1SectionProductDefinition

@Immutable
public final class Grib1SectionProductDefinition
extends java.lang.Object

The Product Definition Section for GRIB-1 files

Constructor Summary

Constructors
Constructor and Description
`Grib1SectionProductDefinition(byte[] rawData)` Set PDS section from byte array.
`Grib1SectionProductDefinition(RandomAccessFile raf)` Read Product Definition section from raf.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bmsExists()` Check if BMS exists from the flag
`long`	`calcCRC()`
`boolean`	`gdsExists()` Check if GDS exists from the flag.
`int`	`getCenter()` Center (octet 5) common code C-1.
`int`	`getDecimalScale()` Units decimal scale factor (octet 27-28) .
`int`	`getFlag()` Flag (octet 8).
`int`	`getGenProcess()` Generating Process (octet 6).
`int`	`getGridDefinition()` Grid Definition (octet 7).
`int`	`getLength()`
`int`	`getLevelType()` Level type (octet 10) - code table 3.
`int`	`getLevelValue1()` Level value1 (octet 11).
`int`	`getLevelValue2()` Level value2 (octet 12).
`int`	`getNincluded()` Number included in statistics (octet 22-23).
`int`	`getNmissing()` Number missing in statistics (octet 24).
`int`	`getParameterNumber()` Parameter number (octet 9) - code table 2.
`int`	`getPerturbationNumber()`
`int`	`getPerturbationType()`
`byte[]`	`getRawBytes()` get the raw bytes of the PDS.
`int`	`getReferenceCentury()` Century of reference (octet 25).
`CalendarDate`	`getReferenceDate()` Reference Date (octet 13-17).
`int`	`getSubCenter()` Center (octet 26) common code C-12.
`int`	`getTableVersion()` gets the Table version (octet 4).
`int`	`getTimeRangeIndicator()` Time range indicator (octet 21) - code table 5.
`int`	`getTimeUnit()` Time unit (octet 18) - code table 4.
`int`	`getTimeValue1()` Time value 1 (octet 19).
`int`	`getTimeValue2()` Time value 2 (octet 20).
`boolean`	`isEnsemble()`
`void`	`showPds(Grib1Customizer cust, java.util.Formatter f)`

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

- Constructor Detail
  - Grib1SectionProductDefinition
```
public Grib1SectionProductDefinition(RandomAccessFile raf)
                              throws java.io.IOException
```
    Read Product Definition section from raf.
    
    Parameters:
    
    raf - RandomAccessFile, with pointer at start of section
    
    Throws:
    
    java.io.IOException - on I/O error
    
    java.lang.IllegalArgumentException - if not a GRIB-2 record
  - Grib1SectionProductDefinition
```
public Grib1SectionProductDefinition(byte[] rawData)
```
    Set PDS section from byte array.
    
    Parameters:
    
    rawData - the byte array
- Method Detail
  - getRawBytes
```
public byte[] getRawBytes()
```
    get the raw bytes of the PDS.
    
    Returns:
    
    PDS as byte[]
  - getLength
```
public int getLength()
```
  - getTableVersion
```
public final int getTableVersion()
```
    gets the Table version (octet 4).
    
    Returns:
    
    table version
  - getCenter
```
public final int getCenter()
```
    Center (octet 5) common code C-1.
    
    Returns:
    
    center id
  - getGenProcess
```
public final int getGenProcess()
```
    Generating Process (octet 6).
    
    Returns:
    
    typeGenProcess
  - getGridDefinition
```
public final int getGridDefinition()
```
    Grid Definition (octet 7). "Number of grid used – from catalogue defined by originating centre". So this is center dependent. "Where octet 7 defines a catalogued grid, that grid should also be defined in Section 2, provided the flag in octet 8 indicates inclusion of Section 2. Octet 7 must be set to 255 to indicate a non-catalogued grid, in which case the grid will be defined in Section 2."
    
    Returns:
    
    Grid Definition.
  - getFlag
```
public final int getFlag()
```
    Flag (octet 8).
    
    Returns:
    
    Flag
  - getParameterNumber
```
public final int getParameterNumber()
```
    Parameter number (octet 9) - code table 2.
    
    Returns:
    
    index number of parameter in table
  - getLevelType
```
public final int getLevelType()
```
    Level type (octet 10) - code table 3.
    
    Returns:
    
    level type
  - getLevelValue1
```
public final int getLevelValue1()
```
    Level value1 (octet 11).
    
    Returns:
    
    level value1
  - getLevelValue2
```
public final int getLevelValue2()
```
    Level value2 (octet 12).
    
    Returns:
    
    level value2
  - getReferenceDate
```
public final CalendarDate getReferenceDate()
```
    Reference Date (octet 13-17). Reference time of data – date and time of start of averaging or accumulation period.
    
    Returns:
    
    Reference Date as CalendarDate.
  - getTimeUnit
```
public final int getTimeUnit()
```
    Time unit (octet 18) - code table 4. Same as GRIB2 Table 4.4
    
    Returns:
    
    time unit
  - getTimeValue1
```
public final int getTimeValue1()
```
    Time value 1 (octet 19). Period of time (number of time units) (0 for analyses or initialized analyses). Units of time given by octet 18
    
    Returns:
    
    time value 1
  - getTimeValue2
```
public final int getTimeValue2()
```
    Time value 2 (octet 20). Period of time (number of time units); or Time interval between successive analyses, initialized analyses or forecasts, undergoing averaging or accumulation. Units of time given by octet 18
    
    Returns:
    
    time value 2
  - getTimeRangeIndicator
```
public final int getTimeRangeIndicator()
```
    Time range indicator (octet 21) - code table 5.
    
    Returns:
    
    Time range indicator
  - getNincluded
```
public final int getNincluded()
```
    Number included in statistics (octet 22-23). Number included in calculation when octet 21 (Code table 5) refers to a statistical process, such as average or accumulation; otherwise set to zero
    
    Returns:
    
    Number included in statistics
  - getNmissing
```
public final int getNmissing()
```
    Number missing in statistics (octet 24). Number missing from calculation in case of statistical process
    
    Returns:
    
    Number missing in statistics
  - getReferenceCentury
```
public final int getReferenceCentury()
```
    Century of reference (octet 25).
    
    Returns:
    
    Century of reference
  - getSubCenter
```
public final int getSubCenter()
```
    Center (octet 26) common code C-12.
    
    Returns:
    
    subcenter id
  - getDecimalScale
```
public final int getDecimalScale()
```
    Units decimal scale factor (octet 27-28) .
    
    Returns:
    
    Units decimal scale factor
  - gdsExists
```
public final boolean gdsExists()
```
    Check if GDS exists from the flag.
    
    Returns:
    
    true, if GDS exists
  - bmsExists
```
public final boolean bmsExists()
```
    Check if BMS exists from the flag
    
    Returns:
    
    true, if BMS exists
  - showPds
```
public void showPds(Grib1Customizer cust,
                    java.util.Formatter f)
```
  - isEnsemble
```
public boolean isEnsemble()
```
  - getPerturbationType
```
public final int getPerturbationType()
```
  - getPerturbationNumber
```
public final int getPerturbationNumber()
```
  - calcCRC
```
public long calcCRC()
```

Class Grib1SectionProductDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Grib1SectionProductDefinition

Grib1SectionProductDefinition

Method Detail

getRawBytes

getLength

getTableVersion

getCenter

getGenProcess

getGridDefinition

getFlag

getParameterNumber

getLevelType

getLevelValue1

getLevelValue2

getReferenceDate

getTimeUnit

getTimeValue1

getTimeValue2

getTimeRangeIndicator

getNincluded

getNmissing

getReferenceCentury

getSubCenter

getDecimalScale

gdsExists

bmsExists

showPds

isEnsemble

getPerturbationType

getPerturbationNumber

calcCRC