GridDefRecord (VisAD-based IOSPs 4.5.5 API)

java.lang.Object
- ucar.nc2.iosp.grid.GridDefRecord

Direct Known Subclasses:

McGridDefRecord, NavigationBlock, Vis5DGridDefRecord
```
public abstract class GridDefRecord
extends Object
```
Class to represent the grid definition (projection) information purpose is to convert from String representation to native value.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANGLE` Angle
`static String`	`BASICANGLE` BasicAngle
`static boolean`	`debug`
`static String`	`DX` distance in X direction
`static String`	`DY` distance in Y direction
`static String`	`GDS_KEY` GDS key
`static String`	`GRID_NAME` grid name
`static String`	`GRID_SHAPE` GRID_SHAPE
`static String`	`GRID_SHAPE_CODE` GRID_SHAPE_CODE
`static String`	`GRID_TYPE` grid type
`static String`	`GRID_UNITS` grid spacing units (DX, DY)
`static String`	`J` J
`static String`	`K` K
`static String`	`LA1` La1
`static String`	`LA2` La2
`static String`	`LAD` LoD
`static String`	`LAP` Lap
`static String`	`LATIN` first lat
`static String`	`LATIN1` first lat
`static String`	`LATIN2` second lat
`static String`	`LO1` Lo1
`static String`	`LO2` Lo2
`static String`	`LOP` Lop
`static String`	`LOV` LoV
`static String`	`M` M
`static String`	`MAJOR_AXIS_EARTH` major axis of earth
`static String`	`METHODNORM` MethodNorm
`static String`	`MINOR_AXIS_EARTH` minor axis of earth
`static String`	`MODEORDER` ModeOrder
`static String`	`NP` Np
`static String`	`NPPROJ` North pole PROJ
`static String`	`NR` Nr
`static String`	`NUMBERPARALLELS` NumberParallels
`static String`	`NX` number of points in X direction (columns)
`static String`	`NY` number of points in Y direction (rows)
`static String`	`PLAT` pLat
`static String`	`PLON` pLon
`static String`	`PROJ` PROJ
`static String`	`QUASI` Quasi
`static String`	`RADIUS_SPHERICAL_EARTH` Radius of spherical earth
`static String`	`RESOLUTION` resolution
`static String`	`ROTATIONANGLE` RotationAngle
`static String`	`SCANNING_MODE` Scanning mode for the data
`static String`	`SPLAT` SpLat
`static String`	`SPLON` SpLon
`static String`	`STRETCHINGFACTOR` StretchingFactor
`static int`	`UNDEFINED` UNDEFINED int value
`static String`	`VECTOR_COMPONENT_FLAG` resolution
`static String`	`WIND_FLAG` Deprecated. use Grib2Tables.VectorComponentFlag
`static String`	`XO` Xo
`static String`	`XP` Xp
`static String`	`YO` Yo
`static String`	`YP` Yp

Constructor Summary

Constructors
Constructor and Description

GridDefRecord()
constructors.

GridDefRecord(String paramsValues)

Constructors
Constructor and Description
`GridDefRecord()` constructors.
`GridDefRecord(String paramsValues)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addParam(String key, double value)` adds a param and value.
`void`	`addParam(String key, Double value)` adds a param and value.
`void`	`addParam(String key, float value)` adds a param and value.
`void`	`addParam(String key, int value)` adds a param and value.
`void`	`addParam(String key, Integer value)` adds a param and value.
`void`	`addParam(String key, String value)` adds a param and value.
`static boolean`	`compare(GridDefRecord local, GridDefRecord other)` Compare GridDefRecords, the numerics will use closeEnough so values that differ in 3 or 4th decimal places will return equal.
`double`	`getDouble(String key)`
`abstract String`	`getGroupName()` Get a short name for this GDSKey for the netCDF group.
`int`	`getInt(String key)`
`Set<String>`	`getKeys()` get the keySet
`String`	`getParam(String key)` gets a param and value.
`double`	`getParamDouble(String key)`
`int`	`getParamInt(String key)`
`String`	`getParamsValues()` get the hcs as a String of params values
`double`	`readDouble(String name)` Deprecated. use getParamDouble(String key)

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

- Field Detail
  - debug
```
public static final boolean debug
```
    See Also:
    Constant Field Values
  - UNDEFINED
```
public static final int UNDEFINED
```
    UNDEFINED int value
    
    See Also:
    Constant Field Values
  - GDS_KEY
```
public static final String GDS_KEY
```
    GDS key
    
    See Also:
    Constant Field Values
  - WIND_FLAG
```
public static final String WIND_FLAG
```
    Deprecated. use Grib2Tables.VectorComponentFlag
    
    Wind flag
    
    See Also:
    Constant Field Values
  - NX
```
public static final String NX
```
    number of points in X direction (columns)
    
    See Also:
    Constant Field Values
  - NY
```
public static final String NY
```
    number of points in Y direction (rows)
    
    See Also:
    Constant Field Values
  - DX
```
public static final String DX
```
    distance in X direction
    
    See Also:
    Constant Field Values
  - DY
```
public static final String DY
```
    distance in Y direction
    
    See Also:
    Constant Field Values
  - RESOLUTION
```
public static final String RESOLUTION
```
    resolution
    
    See Also:
    Constant Field Values
  - VECTOR_COMPONENT_FLAG
```
public static final String VECTOR_COMPONENT_FLAG
```
    resolution
    
    See Also:
    Constant Field Values
  - LATIN
```
public static final String LATIN
```
    first lat
    
    See Also:
    Constant Field Values
  - LATIN1
```
public static final String LATIN1
```
    first lat
    
    See Also:
    Constant Field Values
  - LATIN2
```
public static final String LATIN2
```
    second lat
    
    See Also:
    Constant Field Values
  - LA1
```
public static final String LA1
```
    La1
    
    See Also:
    Constant Field Values
  - LO1
```
public static final String LO1
```
    Lo1
    
    See Also:
    Constant Field Values
  - LA2
```
public static final String LA2
```
    La2
    
    See Also:
    Constant Field Values
  - LO2
```
public static final String LO2
```
    Lo2
    
    See Also:
    Constant Field Values
  - LAD
```
public static final String LAD
```
    LoD
    
    See Also:
    Constant Field Values
  - LOV
```
public static final String LOV
```
    LoV
    
    See Also:
    Constant Field Values
  - LAP
```
public static final String LAP
```
    Lap
    
    See Also:
    Constant Field Values
  - LOP
```
public static final String LOP
```
    Lop
    
    See Also:
    Constant Field Values
  - PLAT
```
public static final String PLAT
```
    pLat
    
    See Also:
    Constant Field Values
  - PLON
```
public static final String PLON
```
    pLon
    
    See Also:
    Constant Field Values
  - SPLAT
```
public static final String SPLAT
```
    SpLat
    
    See Also:
    Constant Field Values
  - SPLON
```
public static final String SPLON
```
    SpLon
    
    See Also:
    Constant Field Values
  - ROTATIONANGLE
```
public static final String ROTATIONANGLE
```
    RotationAngle
    
    See Also:
    Constant Field Values
  - STRETCHINGFACTOR
```
public static final String STRETCHINGFACTOR
```
    StretchingFactor
    
    See Also:
    Constant Field Values
  - ANGLE
```
public static final String ANGLE
```
    Angle
    
    See Also:
    Constant Field Values
  - BASICANGLE
```
public static final String BASICANGLE
```
    BasicAngle
    
    See Also:
    Constant Field Values
  - XP
```
public static final String XP
```
    Xp
    
    See Also:
    Constant Field Values
  - YP
```
public static final String YP
```
    Yp
    
    See Also:
    Constant Field Values
  - XO
```
public static final String XO
```
    Xo
    
    See Also:
    Constant Field Values
  - YO
```
public static final String YO
```
    Yo
    
    See Also:
    Constant Field Values
  - NP
```
public static final String NP
```
    Np
    
    See Also:
    Constant Field Values
  - NR
```
public static final String NR
```
    Nr
    
    See Also:
    Constant Field Values
  - J
```
public static final String J
```
    J
    
    See Also:
    Constant Field Values
  - K
```
public static final String K
```
    K
    
    See Also:
    Constant Field Values
  - M
```
public static final String M
```
    M
    
    See Also:
    Constant Field Values
  - NUMBERPARALLELS
```
public static final String NUMBERPARALLELS
```
    NumberParallels
    
    See Also:
    Constant Field Values
  - METHODNORM
```
public static final String METHODNORM
```
    MethodNorm
    
    See Also:
    Constant Field Values
  - MODEORDER
```
public static final String MODEORDER
```
    ModeOrder
    
    See Also:
    Constant Field Values
  - PROJ
```
public static final String PROJ
```
    PROJ
    
    See Also:
    Constant Field Values
  - NPPROJ
```
public static final String NPPROJ
```
    North pole PROJ
    
    See Also:
    Constant Field Values
  - GRID_TYPE
```
public static final String GRID_TYPE
```
    grid type
    
    See Also:
    Constant Field Values
  - GRID_NAME
```
public static final String GRID_NAME
```
    grid name
    
    See Also:
    Constant Field Values
  - GRID_SHAPE_CODE
```
public static final String GRID_SHAPE_CODE
```
    GRID_SHAPE_CODE
    
    See Also:
    Constant Field Values
  - GRID_SHAPE
```
public static final String GRID_SHAPE
```
    GRID_SHAPE
    
    See Also:
    Constant Field Values
  - RADIUS_SPHERICAL_EARTH
```
public static final String RADIUS_SPHERICAL_EARTH
```
    Radius of spherical earth
    
    See Also:
    Constant Field Values
  - MAJOR_AXIS_EARTH
```
public static final String MAJOR_AXIS_EARTH
```
    major axis of earth
    
    See Also:
    Constant Field Values
  - MINOR_AXIS_EARTH
```
public static final String MINOR_AXIS_EARTH
```
    minor axis of earth
    
    See Also:
    Constant Field Values
  - QUASI
```
public static final String QUASI
```
    Quasi
    
    See Also:
    Constant Field Values
  - GRID_UNITS
```
public static final String GRID_UNITS
```
    grid spacing units (DX, DY)
    
    See Also:
    Constant Field Values
  - SCANNING_MODE
```
public static final String SCANNING_MODE
```
    Scanning mode for the data
    
    See Also:
    Constant Field Values
- Constructor Detail
  - GridDefRecord
```
public GridDefRecord()
```
    constructors.
  - GridDefRecord
```
public GridDefRecord(String paramsValues)
```
- Method Detail
  - addParam
```
public final void addParam(String key,
            String value)
```
    adds a param and value.
    
    Parameters:
    key - name of the param
    value - of the param
  - addParam
```
public final void addParam(String key,
            int value)
```
    adds a param and value.
    
    Parameters:
    key - name of the param
    value - of the param
  - addParam
```
public final void addParam(String key,
            Integer value)
```
    adds a param and value.
    
    Parameters:
    key - name of the param
    value - of the param
  - addParam
```
public final void addParam(String key,
            float value)
```
    adds a param and value.
    
    Parameters:
    key - name of the param
    value - of the param
  - addParam
```
public final void addParam(String key,
            double value)
```
    adds a param and value.
    
    Parameters:
    key - name of the param
    value - of the param
  - addParam
```
public final void addParam(String key,
            Double value)
```
    adds a param and value.
    
    Parameters:
    key - name of the param
    value - of the param
  - getParam
```
public final String getParam(String key)
```
    gets a param and value.
    
    Parameters:
    key - name of the param
    
    Returns:
    the value or null
  - getParamInt
```
public final int getParamInt(String key)
```
  - getInt
```
public final int getInt(String key)
```
  - getParamDouble
```
public final double getParamDouble(String key)
```
  - getDouble
```
public final double getDouble(String key)
```
  - getParamsValues
```
public String getParamsValues()
```
    get the hcs as a String of params values
    
    Returns:
    the hcs as a String of params values
  - getGroupName
```
public abstract String getGroupName()
```
    Get a short name for this GDSKey for the netCDF group. Subclasses should implement as a short description
    
    Returns:
    short name
  - getKeys
```
public final Set<String> getKeys()
```
    get the keySet
    
    Returns:
    the set of keys
  - readDouble
```
public final double readDouble(String name)
```
    Deprecated. use getParamDouble(String key)
    
    returns the value of the param.
    
    Parameters:
    name - param name
    
    Returns:
    value, or NaN if value doest exist
  - compare
```
public static boolean compare(GridDefRecord local,
              GridDefRecord other)
```
    Compare GridDefRecords, the numerics will use closeEnough so values that differ in 3 or 4th decimal places will return equal. This is being coded because the NDFD model dx differ in the 3 decimal place otherwise equal.

Class GridDefRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debug

UNDEFINED

GDS_KEY

WIND_FLAG

NX

NY

DX

DY

RESOLUTION

VECTOR_COMPONENT_FLAG

LATIN

LATIN1

LATIN2

LA1

LO1

LA2

LO2

LAD

LOV

LAP

LOP

PLAT

PLON

SPLAT

SPLON

ROTATIONANGLE

STRETCHINGFACTOR

ANGLE

BASICANGLE

XP

YP

XO

YO

NP

NR

J

K

M

NUMBERPARALLELS

METHODNORM

MODEORDER

PROJ

NPPROJ

GRID_TYPE

GRID_NAME

GRID_SHAPE_CODE

GRID_SHAPE

RADIUS_SPHERICAL_EARTH

MAJOR_AXIS_EARTH

MINOR_AXIS_EARTH

QUASI

GRID_UNITS

SCANNING_MODE

Constructor Detail

GridDefRecord

GridDefRecord

Method Detail

addParam

addParam

addParam

addParam

addParam

addParam

getParam

getParamInt

getInt

getParamDouble

getDouble

getParamsValues

getGroupName

getKeys

readDouble

compare