GempakFileReader (NetCDF-Java All API v5.5.3)

java.lang.Object
- ucar.nc2.iosp.gempak.GempakFileReader

All Implemented Interfaces:

GempakConstants

Direct Known Subclasses:

AbstractGempakStationFileReader, GempakGridReader
```
public class GempakFileReader
extends java.lang.Object
implements GempakConstants
```
Read a Gempak grid file

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`GempakFileReader.DMFileHeaderInfo` Class to hold the DM File header info
`protected static class`	`GempakFileReader.DMHeaders` Class to mimic the DMHDRS common block.
`protected class`	`GempakFileReader.DMKeys` Class to mimic the DMKEYS common block.
`protected static class`	`GempakFileReader.DMParam` Class to hold DM Parameter info
`protected static class`	`GempakFileReader.DMPart` Class to mimic the DMKEYS common block.
`protected static class`	`GempakFileReader.Key` Class to hold information about a key.
`protected static class`	`GempakFileReader.PackingInfo` Class to hold DM Integer packing info
`static class`	`GempakFileReader.RData` A class to hold real (float) data

Field Summary

Fields
Modifier and Type	Field and Description
`protected ucar.nc2.iosp.gempak.GempakFileReader.DMLabel`	`dmLabel` The label common param
`protected java.util.List<GempakFileReader.DMFileHeaderInfo>`	`fileHeaderInfo` header info
`protected long`	`fileSize` file size
`protected GempakFileReader.DMHeaders`	`headers` headers
`protected GempakFileReader.DMKeys`	`keys` key
`protected int`	`MTMACH` the machine type byte order
`protected boolean`	`mvmst` swap flag
`protected boolean`	`needToSwap` swap flag
`protected java.util.List<GempakFileReader.DMPart>`	`parts` part
`protected RandomAccessFile`	`rf` The file

Fields inherited from interface ucar.nc2.iosp.gempak.GempakConstants
COL, IMISSD, LLGDHD, LLNANL, LLNNAV, LLSTHL, MBLKSZ, MDCHAR, MDGDEC, MDGDIF, MDGGRB, MDGNMC, MDGNON, MDGRB2, MDGRID, MDINTG, MDREAL, MDRPCK, MFGD, MFSF, MFSN, MTALPH, MTAPOL, MTHP, MTIBM, MTIGPH, MTIRIS, MTLNUX, MTSUN, MTULTX, MTVAX, RDIFFD, RMISSD, ROW

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GempakFileReader.RData`	`DM_RDTR(int irow, int icol, java.lang.String partName)` Read the data
`GempakFileReader.RData`	`DM_RDTR(int irow, int icol, java.lang.String partName, int decimalScale)` Read the real (float) data
`float`	`DM_RFLT(int word)` Read a float
`void`	`DM_RFLT(int word, float[] rarray)` Convenience method to fully read into an array of floats
`void`	`DM_RFLT(int word, int num, float[] rarray, int start)` Read into an array of ints.
`int`	`DM_RINT(int word)` Read an integer
`void`	`DM_RINT(int word, int[] iarray)` Convenience method to fully read into an array of ints
`void`	`DM_RINT(int word, int num, int[] iarray, int start)` Read into an array of ints.
`float[]`	`DM_RPKG(int isword, int nword, int decimalScale)` subclass should implement
`java.lang.String`	`DM_RSTR(int isword)` Read a 4-byte String
`java.lang.String`	`DM_RSTR(int isword, int nchar)` Read a String
`float[]`	`DM_UNPK(GempakFileReader.DMPart part, int[] ibitst)` Unpack an array of packed integers.
`GempakFileReader.DMFileHeaderInfo`	`findFileHeader(java.lang.String name)` Find the file header with this name
`GempakFileReader.Key`	`findKey(java.lang.String name)` Find a key with the given name
`protected static java.lang.String`	`getBits(int b)` Get a bit string for an integer
`int`	`getByteOrder()` Get the byte order for this system
`int`	`getByteOrder(int kmachn)` Get the byte order for the machine type.
`int`	`getDataPointer(int irow, int icol, java.lang.String partName)` Get the pointer to the data.
`java.lang.String`	`getErrorMessage()`
`static RandomAccessFile`	`getFile(java.lang.String filename)` Get a RandomAccessFile for the file location
`float[]`	`getFileHeader(java.lang.String name)` Read in the values for the file header
`java.lang.String`	`getFilename()` Get the file name.
`long`	`getInitFileSize()` Get initial file size
`static GempakFileReader`	`getInstance(RandomAccessFile raf, boolean fullCheck)` Initialize the file, read in all the metadata (ala DM_OPEN)
`static long`	`getOffset(int fortranWord)` Get the byte offset in 0 based space from a 1 based 4 byte FORTRAN word.
`GempakFileReader.DMPart`	`getPart(java.lang.String name)` Find the part with the particular name.
`int`	`getPartNumber(java.lang.String name)` Find the part with the particular name.
`protected boolean`	`init()` Initialize this reader.
`protected boolean`	`init(boolean fullCheck)` Initialize the file, read in all the metadata (ala DM_OPEN)
`boolean`	`init(RandomAccessFile raf, boolean fullCheck)` Initialize the file, read in all the metadata (ala DM_OPEN)
`protected void`	`logError(java.lang.String errMsg)` Log an error
`void`	`printFileLabel()` Print the file label
`void`	`printHeaders()` Print the row and column keys
`void`	`printKeys()` Print the row and column keys
`void`	`printParts()` Print the part information
`protected void`	`readFileHeaderInfo()` Read the file header info (DM_RFIL)
`protected void`	`readHeaders()` Read the headers (DM_RHDA)
`protected void`	`readKeys()` Read in the row and column keys (DM_KEY)
`protected void`	`readParts()` Read the parts (DM_RPRT)

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

- Field Detail
  - rf
```
protected RandomAccessFile rf
```
    The file
  - dmLabel
```
protected ucar.nc2.iosp.gempak.GempakFileReader.DMLabel dmLabel
```
    The label common param
  - fileHeaderInfo
```
protected java.util.List<GempakFileReader.DMFileHeaderInfo> fileHeaderInfo
```
    header info
  - headers
```
protected GempakFileReader.DMHeaders headers
```
    headers
  - keys
```
protected GempakFileReader.DMKeys keys
```
    key
  - parts
```
protected java.util.List<GempakFileReader.DMPart> parts
```
    part
  - MTMACH
```
protected int MTMACH
```
    the machine type byte order
  - mvmst
```
protected boolean mvmst
```
    swap flag
  - needToSwap
```
protected boolean needToSwap
```
    swap flag
  - fileSize
```
protected long fileSize
```
    file size
- Method Detail
  - getFile
```
public static RandomAccessFile getFile(java.lang.String filename)
                                throws java.io.IOException
```
    Get a RandomAccessFile for the file location
    
    Parameters:
    
    filename - filename to read.
    
    Returns:
    
    RandomAccessFile
    
    Throws:
    
    java.io.IOException - problem reading file
  - getInstance
```
public static GempakFileReader getInstance(RandomAccessFile raf,
                                           boolean fullCheck)
                                    throws java.io.IOException
```
    Initialize the file, read in all the metadata (ala DM_OPEN)
    
    Parameters:
    
    raf - RandomAccessFile to read.
    
    fullCheck - if true, check entire structure
    
    Returns:
    
    a GempakFileReader
    
    Throws:
    
    java.io.IOException - problem reading file
  - init
```
public boolean init(RandomAccessFile raf,
                    boolean fullCheck)
             throws java.io.IOException
```
    Initialize the file, read in all the metadata (ala DM_OPEN)
    
    Parameters:
    
    raf - RandomAccessFile to read.
    
    fullCheck - if true, check entire structure
    
    Throws:
    
    java.io.IOException - problem reading file
  - init
```
protected boolean init()
                throws java.io.IOException
```
    Initialize this reader. Read all the metadata
    
    Returns:
    
    true if successful
    
    Throws:
    
    java.io.IOException - problem reading the data
  - init
```
protected boolean init(boolean fullCheck)
                throws java.io.IOException
```
    Initialize the file, read in all the metadata (ala DM_OPEN)
    
    Parameters:
    
    fullCheck - if true, check entire structure
    
    Returns:
    
    true if successful
    
    Throws:
    
    java.io.IOException - problem reading file
  - getFilename
```
public java.lang.String getFilename()
```
    Get the file name.
    
    Returns:
    
    the name of the file
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
  - getInitFileSize
```
public long getInitFileSize()
```
    Get initial file size
    
    Returns:
    
    the file size when init was called.
  - getByteOrder
```
public int getByteOrder()
```
    Get the byte order for this system
    
    Returns:
    
    byte order
  - getByteOrder
```
public int getByteOrder(int kmachn)
```
    Get the byte order for the machine type.
    
    Parameters:
    
    kmachn - maching type
    
    Returns:
    
    byte order
  - readFileHeaderInfo
```
protected void readFileHeaderInfo()
                           throws java.io.IOException
```
    Read the file header info (DM_RFIL)
    
    Throws:
    
    java.io.IOException - problem reading file
  - readKeys
```
protected void readKeys()
                 throws java.io.IOException
```
    Read in the row and column keys (DM_KEY)
    
    Throws:
    
    java.io.IOException - problem reading file
  - readHeaders
```
protected void readHeaders()
                    throws java.io.IOException
```
    Read the headers (DM_RHDA)
    
    Throws:
    
    java.io.IOException - problem reading file
  - readParts
```
protected void readParts()
                  throws java.io.IOException
```
    Read the parts (DM_RPRT)
    
    Throws:
    
    java.io.IOException - problem reading file
  - getOffset
```
public static long getOffset(int fortranWord)
```
    Get the byte offset in 0 based space from a 1 based 4 byte FORTRAN word.
    
    Parameters:
    
    fortranWord - 1 based word offset
    
    Returns:
    
    byte offset to that word
  - findKey
```
public GempakFileReader.Key findKey(java.lang.String name)
```
    Find a key with the given name
    
    Parameters:
    
    name - the name of the key
    
    Returns:
    
    the key or null;
  - findFileHeader
```
public GempakFileReader.DMFileHeaderInfo findFileHeader(java.lang.String name)
```
    Find the file header with this name
    
    Parameters:
    
    name - name of header
    
    Returns:
    
    headerinfo or null if not found
  - getFileHeader
```
public float[] getFileHeader(java.lang.String name)
                      throws java.io.IOException
```
    Read in the values for the file header
    
    Parameters:
    
    name - name of header
    
    Returns:
    
    values or null if not found
    
    Throws:
    
    java.io.IOException - problem reading file
  - logError
```
protected void logError(java.lang.String errMsg)
```
    Log an error
    
    Parameters:
    
    errMsg - message to log
  - printFileLabel
```
public void printFileLabel()
```
    Print the file label
  - printKeys
```
public void printKeys()
```
    Print the row and column keys
  - printHeaders
```
public void printHeaders()
```
    Print the row and column keys
  - printParts
```
public void printParts()
```
    Print the part information
  - getPartNumber
```
public int getPartNumber(java.lang.String name)
```
    Find the part with the particular name.
    
    Parameters:
    
    name - name of part to find
    
    Returns:
    
    part number.
  - getPart
```
public GempakFileReader.DMPart getPart(java.lang.String name)
```
    Find the part with the particular name.
    
    Parameters:
    
    name - name of part to find
    
    Returns:
    
    part or null if not found
  - getDataPointer
```
public int getDataPointer(int irow,
                          int icol,
                          java.lang.String partName)
```
    Get the pointer to the data. Taken from DM_RDTR
    
    Parameters:
    
    irow - row number
    
    icol - column number
    
    partName - name of the part
    
    Returns:
    
    word (1 based) of start of data.
  - DM_RINT
```
public int DM_RINT(int word)
            throws java.io.IOException
```
    Read an integer
    
    Parameters:
    
    word - word in file (1 based) to read
    
    Returns:
    
    int read
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RINT
```
public void DM_RINT(int word,
                    int[] iarray)
             throws java.io.IOException
```
    Convenience method to fully read into an array of ints
    
    Parameters:
    
    word - word in file (1 based) to read
    
    iarray - array to read into
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RINT
```
public void DM_RINT(int word,
                    int num,
                    int[] iarray,
                    int start)
             throws java.io.IOException
```
    Read into an array of ints.
    
    Parameters:
    
    word - word in file (1 based) to read
    
    iarray - array to read into
    
    start - starting word in the array (0 based)
    
    num - number of words to read
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RFLT
```
public float DM_RFLT(int word)
              throws java.io.IOException
```
    Read a float
    
    Parameters:
    
    word - word in file (1 based) to read
    
    Returns:
    
    float read
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RFLT
```
public void DM_RFLT(int word,
                    float[] rarray)
             throws java.io.IOException
```
    Convenience method to fully read into an array of floats
    
    Parameters:
    
    word - word in file (1 based) to read
    
    rarray - array to read into
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RFLT
```
public void DM_RFLT(int word,
                    int num,
                    float[] rarray,
                    int start)
             throws java.io.IOException
```
    Read into an array of ints.
    
    Parameters:
    
    word - word in file (1 based) to read
    
    num - number of words to read
    
    rarray - array to read into
    
    start - starting word in the array (0 based)
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RSTR
```
public java.lang.String DM_RSTR(int isword)
                         throws java.io.IOException
```
    Read a 4-byte String
    
    Parameters:
    
    isword - offset in file (1 based FORTRAN word)
    
    Returns:
    
    String read
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RSTR
```
public java.lang.String DM_RSTR(int isword,
                                int nchar)
                         throws java.io.IOException
```
    Read a String
    
    Parameters:
    
    isword - offset in file (1 based FORTRAN word)
    
    nchar - number of characters to read
    
    Returns:
    
    String read
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RDTR
```
public GempakFileReader.RData DM_RDTR(int irow,
                                      int icol,
                                      java.lang.String partName)
                               throws java.io.IOException
```
    Read the data
    
    Parameters:
    
    irow - row to read
    
    icol - column to read
    
    partName - part name
    
    Returns:
    
    the header and data array or null;
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_RDTR
```
public GempakFileReader.RData DM_RDTR(int irow,
                                      int icol,
                                      java.lang.String partName,
                                      int decimalScale)
                               throws java.io.IOException
```
    Read the real (float) data
    
    Parameters:
    
    irow - row to read
    
    icol - column to read
    
    partName - part name
    
    decimalScale - scaling factor (power of 10);
    
    Returns:
    
    the header and data array or null;
    
    Throws:
    
    java.io.IOException - problem reading file
  - DM_UNPK
```
public float[] DM_UNPK(GempakFileReader.DMPart part,
                       int[] ibitst)
```
    Unpack an array of packed integers.
    
    Parameters:
    
    part - the part with packing info
    
    ibitst - packed integer bit string
    
    Returns:
    
    unpacked ints as floats
  - getBits
```
protected static java.lang.String getBits(int b)
```
    Get a bit string for an integer
    
    Parameters:
    
    b - the integer
    
    Returns:
    
    a bit string (e.g.: 01100001|11000000|10011010|10110100|)
  - DM_RPKG
```
public float[] DM_RPKG(int isword,
                       int nword,
                       int decimalScale)
                throws java.io.IOException
```
    subclass should implement
    
    Parameters:
    
    isword - starting word (1 based)
    
    nword - number of words to read
    
    decimalScale - decimal scale
    
    Returns:
    
    returns null unless subclass overrides
    
    Throws:
    
    java.io.IOException - problem reading data

Class GempakFileReader

Nested Class Summary

Field Summary

Fields inherited from interface ucar.nc2.iosp.gempak.GempakConstants

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rf

dmLabel

fileHeaderInfo

headers

keys

parts

MTMACH

mvmst

needToSwap

fileSize

Method Detail

getFile

getInstance

init

init

init

getFilename

getErrorMessage

getInitFileSize

getByteOrder

getByteOrder

readFileHeaderInfo

readKeys

readHeaders

readParts

getOffset

findKey

findFileHeader

getFileHeader

logError

printFileLabel

printKeys

printHeaders

printParts

getPartNumber

getPart

getDataPointer

DM_RINT

DM_RINT

DM_RINT

DM_RFLT

DM_RFLT

DM_RFLT

DM_RSTR

DM_RSTR

DM_RDTR

DM_RDTR

DM_UNPK

getBits

DM_RPKG