ucar.nc2.iosp.misc
Class Uspln

java.lang.Object
  ucar.nc2.iosp.AbstractIOServiceProvider
      ucar.nc2.iosp.misc.Uspln

All Implemented Interfaces:

IOServiceProvider

public class Uspln
extends AbstractIOServiceProvider

UspLightning3 This looks like the most recent USPLN iosp.

Author:

caron

Field Summary

Fields inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

raf

Constructor Summary

Uspln()

Method Summary

java.lang.String	getFileTypeDescription() Get a human-readable description for this file type.
java.lang.String	getFileTypeId() Get a unique id for this file type.
boolean	isValidFile(RandomAccessFile raf) Check if this is a valid file for this IOServiceProvider.
void	open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) Open existing file, and populate ncfile with it.
Array	readData(Variable v2, Section section) Read data from a top level Variable and return a memory resident Array.
Array	readNestedData(Variable v2, Section section)

Methods inherited from class ucar.nc2.iosp.AbstractIOServiceProvider

close, copyToByteChannel, createValidNetcdfObjectName, getDetailInfo, getFileTypeVersion, getStructureIterator, readSection, readToByteChannel, sendIospMessage, sync, syncExtend, toStringDebug

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Uspln

public Uspln()

Method Detail

isValidFile

public boolean isValidFile(RandomAccessFile raf)
                    throws java.io.IOException

Description copied from interface: IOServiceProvider

Check if this is a valid file for this IOServiceProvider. You must make this method thread safe, ie dont keep any state.

Parameters:

raf - RandomAccessFile

Returns:

true if valid.

Throws:

java.io.IOException - if read error

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws java.io.IOException

Description copied from interface: IOServiceProvider

Open existing file, and populate ncfile with it. This method is only called by the NetcdfFile constructor on itself. The provided NetcdfFile object will be empty except for the location String and the IOServiceProvider associated with this NetcdfFile object.

Parameters:

raf - the file to work on, it has already passed the isValidFile() test.

ncfile - add objects to this empty NetcdfFile

cancelTask - used to monitor user cancellation; may be null.

Throws:

java.io.IOException - if read error

readNestedData

public Array readNestedData(Variable v2,
                            Section section)
                     throws java.io.IOException,
                            InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

readData

public Array readData(Variable v2,
                      Section section)
               throws java.io.IOException,
                      InvalidRangeException

Description copied from interface: IOServiceProvider

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

section - the section of data to read. There must be a Range for each Dimension in the variable, in order. Note: no nulls allowed. IOSP may not modify.

Returns:

the requested data in a memory-resident Array

Throws:

java.io.IOException - if read error

InvalidRangeException - if invalid section

See Also:

Range

getFileTypeId

public java.lang.String getFileTypeId()

Description copied from interface: IOServiceProvider

Get a unique id for this file type.

Returns:

registered id of the file type

See Also:

"http://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

getFileTypeDescription

public java.lang.String getFileTypeDescription()

Description copied from interface: IOServiceProvider

Get a human-readable description for this file type.

Returns:

description of the file type

See Also:

"http://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"