|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.gsfc.drl.rtstps.core.output.hdf5.CommonDataSetObject
gov.nasa.gsfc.drl.rtstps.core.output.hdf5.Aggregate
public class Aggregate
Create or read the Aggregrate
metadata from an RDR file. The RDR file is specified
by an input handle, and assumed to be opened outside of this class. An Aggregate consists of certain
attributes that contain among other things Granule
start/stop times, counts and other items. The Aggregate
itself references the items in the HDF and is defined the JPSS metadata documentation.
Field Summary | |
---|---|
private java.lang.String |
aggregateName
|
private java.lang.String |
begDateStr
|
private PDSDate |
beginningDateTime
|
private GranuleId |
beginningGranuleId
|
private long |
beginningOrbit
|
private java.lang.String |
begTimeStr
|
private int |
dataSet
|
private int |
dataSpace
|
private java.lang.String |
endDateStr
|
private PDSDate |
endingDateTime
|
private GranuleId |
endingGranuleId
|
private long |
endingOrbit
|
private java.lang.String |
endTimeStr
|
private long |
granuleCount
|
private RDRName |
rdrReferenceName
|
Constructor Summary | |
---|---|
Aggregate(GranuleId beginningGranuleId,
GranuleId endingGranuleId,
long beginningOrbit,
long endingOrbit,
PDSDate beginningDateTime,
PDSDate endingDateTime,
long granuleCount,
RDRName rdrReferenceName)
Constructor for creating a new Aggregate in the RDR. |
|
Aggregate(int rdrGroup,
RDRName rdrName)
Constructor for reading a pre-existing Aggregate . |
|
Aggregate(int rdrGroup,
java.lang.String aggregateName)
Constructor for reading a pre-existing Aggregate . |
Method Summary | |
---|---|
void |
close()
Close the RDR/HDF Aggregate structure after calling the write method above. |
java.lang.String |
getBeginningDateFormatted()
Returns the formatted date String of the BeginningDateTime as follows: yyyyMMdd |
PDSDate |
getBeginningDateTime()
Returns the beginning date and time of the first Granule in this Aggregate as a Spacecraft PDS formated date and time. |
GranuleId |
getBeginningGranuleId()
Returns the beginning Granule identifier |
long |
getBeginningOrbit()
Returns the beginning orbit |
java.lang.String |
getBeginningTimeFormatted()
Returns the formatted time String of the BeginningDateTime as follows: HHmmss.SSS |
java.lang.String |
getEndingDateFormatted()
Returns the formatted date String of the EndingDateTime as follows: yyyyMMdd |
PDSDate |
getEndingDateTime()
Returns the end date and time of the last Granule in this Aggregate as a Spacecraft PDS formated date and time. |
GranuleId |
getEndingGranuleId()
Returns the ending Granule identifier |
long |
getEndingOrbit()
Returns the ending orbit |
java.lang.String |
getEndingTimeFormatted()
Returns the formatted time String of the EndingDateTime as follows: HHmmss.SSS |
long |
getGranuleCount()
Returns the Granule count, the number of Granules that make up the Aggregate |
RDRAllReader |
getReferencedRDRAll()
Return the RDR_All RDRAllReader that the reference points to in the Aggregate |
private void |
readAttributes()
|
void |
write(int hdfFile)
Write this Aggregrate to the HDF files according to the RDR format. |
private void |
writeAttributes()
Write the various attributes associated with the Aggregate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private int dataSpace
private int dataSet
private GranuleId beginningGranuleId
private GranuleId endingGranuleId
private long beginningOrbit
private long endingOrbit
private RDRName rdrReferenceName
private java.lang.String aggregateName
private long granuleCount
private java.lang.String begTimeStr
private java.lang.String endDateStr
private java.lang.String endTimeStr
private java.lang.String begDateStr
private PDSDate beginningDateTime
private PDSDate endingDateTime
Constructor Detail |
---|
public Aggregate(int rdrGroup, java.lang.String aggregateName) throws RtStpsException
Aggregate
.
rdrGroup
- the RDR group on the HDF the Aggregrate is in such as /Data_Products/XXX-RDRaggregateName
- the aggregate name in the group like: SPACECRAFT-DIARY-RDR_Aggr
RtStpsException
public Aggregate(int rdrGroup, RDRName rdrName) throws RtStpsException
Aggregate
.
rdrGroup
- the RDR group on the HDF the Aggregrate is in such as /Data_Products/XXX-RDRaggregateName
- the aggregate name in the group like: SPACECRAFT-DIARY-RDR_Aggr
RtStpsException
public Aggregate(GranuleId beginningGranuleId, GranuleId endingGranuleId, long beginningOrbit, long endingOrbit, PDSDate beginningDateTime, PDSDate endingDateTime, long granuleCount, RDRName rdrReferenceName)
Aggregate
in the RDR. It takes several arguments.
beginningGranuleId
- The first Granule
that constitutes this Aggregate
endingGranuleId
- The last Granule
that constitutes this Aggregate
beginningOrbit
- The first orbit that constitutes this Aggregate
endingOrbit
- The last orbit that constitutes this Aggregate
beginningDateTime
- The beginning date and time of the Granules
in spacecraft timeendingDateTime
- The ending date and time of the Granules
in spacecraft timegranuleCount
- The number of Granules in the Aggregate
rdrReferenceName
- The RDR name associated with this Aggregate
Method Detail |
---|
public RDRAllReader getReferencedRDRAll() throws RtStpsException
RtStpsException
public final GranuleId getBeginningGranuleId()
Granule
identifier
public final long getBeginningOrbit()
public final GranuleId getEndingGranuleId()
Granule
identifier
public final long getEndingOrbit()
public final PDSDate getBeginningDateTime()
Granule
in this Aggregate
as a Spacecraft PDS formated date and time.
PDSDate
public final java.lang.String getBeginningDateFormatted()
String
of the BeginningDateTime as follows: yyyyMMdd
String
containing the formatted datepublic final java.lang.String getBeginningTimeFormatted()
String
of the BeginningDateTime as follows: HHmmss.SSS
String
contained the formatted timepublic final PDSDate getEndingDateTime()
Granule
in this Aggregate
as a Spacecraft PDS formated date and time.
PDSDate
public final java.lang.String getEndingDateFormatted()
String
of the EndingDateTime as follows: yyyyMMdd
String
containing the formatted datepublic final java.lang.String getEndingTimeFormatted()
String
of the EndingDateTime as follows: HHmmss.SSS
String
contained the formatted timepublic final long getGranuleCount()
Granule
count, the number of Granules
that make up the Aggregate
Granule
count as a longpublic void write(int hdfFile) throws RtStpsException
Aggregrate
to the HDF files according to the RDR format. In particular it
creates the /Data_Products/XXX-XXXX-RDR/XXX-XXXX-RDR_Aggr structure.
hdfFile
- the handle from the HDF file to the root of the HDF structure
RtStpsException
- Wraps any exceptions thrown by the HDF libraryprivate void writeAttributes() throws RtStpsException
Aggregate
RtStpsException
- Wraps any exceptions thrown by the HDF libraryprivate void readAttributes() throws RtStpsException
RtStpsException
public void close() throws RtStpsException
close
in class CommonDataSetObject
RtStpsException
- Wraps any exceptions thrown by the HDF library
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |