Package ucar.nc2.iosp.uamiv

Class UAMIVServiceProvider

  • All Implemented Interfaces:
    ucar.nc2.iosp.IOServiceProvider
    public class UAMIVServiceProvider
extends ucar.nc2.iosp.AbstractIOServiceProvider
    Class for reading CAMx flavored uamiv files. CAMx UAM-IV formatted files. uses "IOAP Conventions", handled by M3IO CoordSysBuilder
    See Also:
    "http://www.camx.com/"

    • Field Summary

      • Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

        location, ncfile, raf, rafOrder

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getFileTypeDescription()  
      String getFileTypeId()  
      boolean isValidFile​(ucar.unidata.io.RandomAccessFile raf)
      Check if this is a valid file for this IOServiceProvider.
      void open​(ucar.unidata.io.RandomAccessFile raf, ucar.nc2.NetcdfFile ncfile, ucar.nc2.util.CancelTask cancelTask)
      Open existing file, and populate ncfile with it.
      ucar.ma2.Array readData​(ucar.nc2.Variable v2, ucar.ma2.Section wantSection)
      Read data from a top level Variable and return a memory resident Array.

      • Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

        build, buildFinish, close, getDetailInfo, getFileTypeVersion, getLastModified, getStructureIterator, isBuilder, reacquire, readSection, readToByteChannel, readToOutputStream, release, sendIospMessage, setNetcdfFile, streamToByteChannel, syncExtend, toStringDebug

    • Constructor Detail

      • UAMIVServiceProvider

        public UAMIVServiceProvider()

    • Method Detail

      • isValidFile

        public boolean isValidFile​(ucar.unidata.io.RandomAccessFile raf)
        Check if this is a valid file for this IOServiceProvider.
        Parameters:
        raf - RandomAccessFile
        Returns:
        true if valid.

      • getFileTypeId

        public String getFileTypeId()

      • getFileTypeDescription

        public String getFileTypeDescription()

      • open

        public void open​(ucar.unidata.io.RandomAccessFile raf,
                 ucar.nc2.NetcdfFile ncfile,
                 ucar.nc2.util.CancelTask cancelTask)
          throws IOException
        Open existing file, and populate ncfile with it.
        Specified by:
        open in interface ucar.nc2.iosp.IOServiceProvider
        Overrides:
        open in class ucar.nc2.iosp.AbstractIOServiceProvider
        Parameters:
        raf - the file to work on, it has already passed the isValidFile() test.
        ncfile - add objects to this NetcdfFile
        cancelTask - used to monito user cancellation; may be null.
        Throws:
        IOException

      • readData

        public ucar.ma2.Array readData​(ucar.nc2.Variable v2,
                               ucar.ma2.Section wantSection)
                        throws IOException,
                               ucar.ma2.InvalidRangeException
        Read data from a top level Variable and return a memory resident Array. This Array has the same element type as the Variable, and the requested shape.
        Parameters:
        v2 - a top-level Variable
        wantSection - List of type Range specifying the section of data to read. There must be a Range for each Dimension in the variable, in order. Note: no nulls.
        Returns:
        the requested data in a memory-resident Array
        Throws:
        IOException
        ucar.ma2.InvalidRangeException
        See Also:
        Range