public class H5iosp extends AbstractIOServiceProvider
Modifier and Type | Field and Description |
---|---|
static String |
IOSP_MESSAGE_INCLUDE_ORIGINAL_ATTRIBUTES |
static int |
VLEN_T_SIZE |
location, ncfile, raf, rafOrder
Constructor and Description |
---|
H5iosp() |
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the file.
|
String |
getDetailInfo()
Show debug / underlying implementation details
|
void |
getEosInfo(Formatter f) |
String |
getFileTypeDescription()
Get a human-readable description for this file type.
|
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.
|
Object |
sendIospMessage(Object message)
A way to communicate arbitrary information to an iosp.
|
static void |
setDebugFlags(DebugFlags debugFlag) |
String |
toStringDebug(Object o)
Debug info for this object.
|
getFileTypeVersion, getLastModified, getStructureIterator, reacquire, readSection, readToByteChannel, readToOutputStream, release, streamToByteChannel, syncExtend
public static final String IOSP_MESSAGE_INCLUDE_ORIGINAL_ATTRIBUTES
public static final int VLEN_T_SIZE
public static void setDebugFlags(DebugFlags debugFlag)
public boolean isValidFile(RandomAccessFile raf) throws IOException
IOServiceProvider
raf
- RandomAccessFileIOException
- if read errorpublic String getFileTypeId()
IOServiceProvider
public String getFileTypeDescription()
IOServiceProvider
public void getEosInfo(Formatter f) throws IOException
IOException
public void open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) throws IOException
IOServiceProvider
open
in interface IOServiceProvider
open
in class AbstractIOServiceProvider
raf
- the file to work on, it has already passed the isValidFile() test.ncfile
- add objects to this empty NetcdfFilecancelTask
- used to monitor user cancellation; may be null.IOException
- if read errorpublic Array readData(Variable v2, Section section) throws IOException, InvalidRangeException
IOServiceProvider
v2
- a top-level Variablesection
- 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.IOException
- if read errorInvalidRangeException
- if invalid sectionRange
public void close() throws IOException
close
in interface IOServiceProvider
close
in class AbstractIOServiceProvider
IOException
- on io errorpublic String toStringDebug(Object o)
toStringDebug
in interface IOServiceProvider
toStringDebug
in class AbstractIOServiceProvider
o
- which objectpublic String getDetailInfo()
IOServiceProvider
getDetailInfo
in interface IOServiceProvider
getDetailInfo
in class AbstractIOServiceProvider
public Object sendIospMessage(Object message)
IOServiceProvider
sendIospMessage
in interface IOServiceProvider
sendIospMessage
in class AbstractIOServiceProvider
message
- opaque message sent to the IOSP object when its opened (not when isValidFile() is called)Copyright © 1999–2017 UCAR/Unidata. All rights reserved.