gov.nasa.gsfc.drl.rtstps.core.output.hdf5
Class AllData

java.lang.Object
  extended by gov.nasa.gsfc.drl.rtstps.core.output.hdf5.AllData

public class AllData
extends java.lang.Object

Build the AllData portion of the RDR HDF file structure. The HDF file handle is passed into the class and it assumed that it was opened or created in another location. Once successfully created, the object may be used to create the RDR All area as well.


Field Summary
private  int allDataGroup
           
private  int hdfFile
           
 
Constructor Summary
AllData(int hdfFile)
          Constructor for AllData structure in the RDR uses the HDF handle as an argument to the HDF file of interest.
 
Method Summary
 void close()
          Close the HDF All_Data group.
 RDRAll createRDRAll(RDRName rdrName)
          Create an RDR_All group in /All_Data for the named RDR.
 int getAllDataGroupHandle()
          Return the HDF group handle for the All_Data group
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

hdfFile

private int hdfFile

allDataGroup

private int allDataGroup
Constructor Detail

AllData

public AllData(int hdfFile)
        throws RtStpsException
Constructor for AllData structure in the RDR uses the HDF handle as an argument to the HDF file of interest. Given the handle it creates the "/All_Data" group in the RDR/HDF file. Note that the HDF group is probably not complete until the close method is called at the end of processing.

Parameters:
hdfFile - a handle to an HDF file of interest
Throws:
RtStpsException - Wraps any HDF library exceptions in an RtStpsException
Method Detail

createRDRAll

public RDRAll createRDRAll(RDRName rdrName)
                    throws RtStpsException
Create an RDR_All group in /All_Data for the named RDR. And instance of RDRAll is created which is used to manage that specified XXXX-RDR_All. (e.g. VIIRS-SCIENCE-RDR_All)

Parameters:
rdrName - the name of an RDR such as VIIRS-SCIENCE-RDR, specified using the list of supported RDRs in the RDRName enumeration
Returns:
returns an instance of RDRAll for the named RDR
Throws:
RtStpsException - Wraps any HDF library exceptions in an RtStpsException

getAllDataGroupHandle

public int getAllDataGroupHandle()
Return the HDF group handle for the All_Data group

Returns:
an integer handle to the HDF group

close

public void close()
           throws RtStpsException
Close the HDF All_Data group. This must be called to complete the HDF creation of All_Data and should be done after the completion of processing.

Throws:
RtStpsException - Wraps any HDF library exceptions in an RtStpsException