net.sourceforge.jgrib.util
Class GribRecHeader

java.lang.Object
  extended by net.sourceforge.jgrib.util.GribRecHeader
All Implemented Interfaces:
java.lang.Comparable

public class GribRecHeader
extends java.lang.Object
implements java.lang.Comparable

GRIB Record Header
Purpose: Organize GRIB records using their key fields. Avoids memory overhead by not including body data, ie. GribRecord's or GribRecordLight's. torc


Field Summary
static int F_DATE
          Forecast date
static int F_GDS
          Grid Definition Section
static int F_LEV_TYP
          Level type (2D or 3D)
static int F_LEV_Z
          Actual level (Z level if 3D)
static int F_PAR
          Parameter varName
static int[] mDefaultFldOrder
          Default Field Order: F_GDS, F_LEV_TYP, F_PAR, F_DATE, F_LEV_Z
static int NUM_FIELDS
          Total number of fields
 
Constructor Summary
GribRecHeader(int index, GribRecord rec)
           
GribRecHeader(int index, GribRecordLight rec)
           
 
Method Summary
 int compareField(int aFld, java.lang.Object o2)
           
 int compareTo(java.lang.Object obj)
           
 java.util.Date getDate()
          F_DATE
 GribRecordGDS getGDS()
          F_GDS
 int getIx()
           
 GribPDSParameter getParam()
          F_PAR
 java.lang.String getParamDescr()
           
 java.lang.String getParamName()
          F_PAR
 java.lang.String getParamUnit()
           
 GribPDSLevel getPDSLev()
          F_LEV_Z
 int getPDSLevType()
          F_LEV_TYP
 float getPDSLevZvalue()
          F_LEV_Z
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

F_GDS

public static final int F_GDS
Grid Definition Section

See Also:
Constant Field Values

F_LEV_TYP

public static final int F_LEV_TYP
Level type (2D or 3D)

See Also:
Constant Field Values

F_PAR

public static final int F_PAR
Parameter varName

See Also:
Constant Field Values

F_DATE

public static final int F_DATE
Forecast date

See Also:
Constant Field Values

F_LEV_Z

public static final int F_LEV_Z
Actual level (Z level if 3D)

See Also:
Constant Field Values

NUM_FIELDS

public static final int NUM_FIELDS
Total number of fields

See Also:
Constant Field Values

mDefaultFldOrder

public static final int[] mDefaultFldOrder
Default Field Order: F_GDS, F_LEV_TYP, F_PAR, F_DATE, F_LEV_Z

Constructor Detail

GribRecHeader

public GribRecHeader(int index,
                     GribRecord rec)
Parameters:
index -
rec -

GribRecHeader

public GribRecHeader(int index,
                     GribRecordLight rec)
Parameters:
index -
rec -
Method Detail

getGDS

public GribRecordGDS getGDS()
F_GDS

Returns:
gds - GribRecordGDS

getPDSLevType

public int getPDSLevType()
F_LEV_TYP

Returns:
PDS level type

getParam

public GribPDSParameter getParam()
F_PAR

Returns:
parameter

getParamName

public java.lang.String getParamName()
F_PAR

Returns:
parameter name

getParamUnit

public java.lang.String getParamUnit()
Returns:
parameter unit

getParamDescr

public java.lang.String getParamDescr()
Returns:
parameter description

getDate

public java.util.Date getDate()
F_DATE

Returns:
date

getPDSLev

public GribPDSLevel getPDSLev()
F_LEV_Z

Returns:
pds level

getPDSLevZvalue

public float getPDSLevZvalue()
F_LEV_Z

Returns:
pds z level value

compareField

public int compareField(int aFld,
                        java.lang.Object o2)
Parameters:
aFld -
o2 -
Returns:
result of comparation

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable
See Also:
Comparable.compareTo(java.lang.Object)

getIx

public int getIx()
Returns:
ix

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()