Package hec.io

Class TimeSeriesContainerVertDatum

java.lang.Object

hec.io.DataContainer

hec.io.TimeSeriesContainer

hec.io.TimeSeriesContainerVertDatum

All Implemented Interfaces:

IVerticalDatumOperations<TimeSeriesContainer,mil.army.usace.hec.metadata.VerticalDatumException>, Serializable, Cloneable, mil.army.usace.hec.metadata.VerticalDatum

public class TimeSeriesContainerVertDatum
extends TimeSeriesContainer
implements mil.army.usace.hec.metadata.VerticalDatum

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hec.io.DataContainer

DataContainer.VERTICAL_DATUM, DataContainer.VERTICAL_UNITS

Field Summary

Fields

Modifier and Type	Field	Description
protected mil.army.usace.hec.metadata.VerticalDatumContainer	vdc

Fields inherited from class hec.io.TimeSeriesContainer

cnotes, endHecTime, endTime, inotes, interval, julianBaseDate, numberDepths, numberValues, parameter, precision, profileDepths, profileLabel, profileValues, quality, quality7, retrieveAllTimes, sizeEachNote, sizeEachQuality7, startHecTime, startTime, subLocation, subParameter, timeGranularitySeconds, times, timeZoneID, timeZoneRawOffset, type, units, unitsProfileDepths, unitsProfileValues, values

Fields inherited from class hec.io.DataContainer

coordinateID, coordinateSystem, CURRENT_VERTICAL_DATUM_HEADER, CURRENT_VERTICAL_DATUM_KEY, dataType, fileLastWriteTimeMillis, fileName, fullName, horizontalDatum, horizontalUnits, lastWriteTimeMillis, location, locationTimezone, modified, otherInfo, storedAsdoubles, subVersion, supplementalInfo, version, VERTICAL_DATUM_INFO_HEADER, VERTICAL_DATUM_INFO_KEY, verticalDatum, verticalUnits, watershed, xOrdinate, yOrdinate, zOrdinate

Constructor Summary

Constructors

Constructor	Description
TimeSeriesContainerVertDatum()	Public constructor
TimeSeriesContainerVertDatum(TimeSeriesContainer tsc)	Public constructor
TimeSeriesContainerVertDatum(TimeSeriesContainer tsc, mil.army.usace.hec.metadata.VerticalDatumContainer vdc)	Public constructor
TimeSeriesContainerVertDatum(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)	Public constructor

Method Summary

Modifier and Type	Method	Description
Object	clone()	clone the TimeSerieContainer
void	clone(TimeSeriesContainer tsc)	clone this TimeSeriesContainer into tsc
void	convertVerticalDatumUnits(String strUnit)
mil.army.usace.hec.metadata.VerticalDatumContainer	extractVerticalDatum()	Extracts any verticalDatumInfo string in the supplementalInfo to a VerticalDatumContainer and removes the string from the supplementalInfo.
boolean	forceVerticalDatum(String datum)
double	getCurrentOffset()
double	getCurrentOffset(String unit)
String	getCurrentVerticalDatum()
String	getNativeVerticalDatum()
double	getNAVD88Offset()
double	getNAVD88Offset(String unit)
double	getNGVD29Offset()
double	getNGVD29Offset(String unit)
mil.army.usace.hec.metadata.VerticalDatumContainer	getVerticalDatumContainer()	Returns the Vertical Datum Container
String	getVerticalDatumInfo()
final Optional<mil.army.usace.hec.metadata.VerticalDatum>	getVerticalDatumMetadata()
void	insertVerticalDatum(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)	Inserts the text representation a VerticalDatumContainer into the supplementalInfo field of a DataContainer object, replacing any existing vertical datum information in the field
static boolean	isCorrectParameter(String pm)
boolean	isCurrentVerticalDatumEstimated()
boolean	isNAVD88OffsetEstimated()
boolean	isNGVD29OffsetEstimated()
void	setVerticalDatumContainer(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)	Sets the VerticalDatumContainer member of this object from the specified VerticalDatumContainer
void	setVerticalDatumInfo(String xmlStr)
boolean	toNativeVerticalDatum()
boolean	toNAVD88()
boolean	toNGVD29()
boolean	toVerticalDatum(String datum)

Methods inherited from class hec.io.TimeSeriesContainer

allMissing, collapseVerticalDatum, compressData, convertTimeZone, convertTimeZone, expandVerticalDatum, getAsString, getAsXML, getCharacterNotes, getDataSetStats, getEndTime, getFullVersionedName, getHecTime, getJulianBaseDate, getJulianDateAndTimeGranularity, getLocationName, getMinutes, getMinutesLong, getMinutesLong, getNumberValues, getParameterName, getProfileDepths, getProfileDepthsUnits, getProfileLabel, getProfileNumberDepths, getProfileValues, getProfileValuesUnits, getQuality, getQuality7, getQualitySize, getShortName, getStartTime, getTimeGranularitySeconds, getTimeInterval, getTimeIntervalSeconds, getTimes, getTimeZoneID, getType, getUnits, getValue, getValue, getValues, getVersionDate, getVersionName, hasValidProfileData, makeAscending, maximumValue, maxmimumValue, mean, minimumValue, printToConsole, printToConsole, removeAllMissing, set, set, set, set, setCharacterNotes, setCompressData, setEndTime, setJulianBaseDate, setProfile, setProfileDepthsUnits, setProfileLabel, setProfileValuesUnits, setQuality, setQuality7, setStartTime, setTimeGranularitySeconds, setTimes, setTimeZoneID, setType, setUnits, setValues, setVersionDate, trimToTime, trimToTime, usesExtendedDates

Methods inherited from class hec.io.DataContainer

clone, getFullName, getHorizontalDatum, getLatLong, getName, getStoreAsDoubles, getSupplementalInfo, getVerticalDatum, getVerticalUnits, setFullName, setHorizontalDatum, setLatLong, setName, setStoreAsDoubles, setSupplementalInfo, setVerticalDatum, setVerticalDatum, setVerticalUnits, setVerticalUnits, toString

Methods inherited from class java.lang.Object

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

Field Details

vdc

protected mil.army.usace.hec.metadata.VerticalDatumContainer vdc

Constructor Details

TimeSeriesContainerVertDatum

public TimeSeriesContainerVertDatum()

Public constructor

TimeSeriesContainerVertDatum

public TimeSeriesContainerVertDatum(TimeSeriesContainer tsc)

Public constructor

Parameters:

tsc - A TimeSeriesContainer object to initialize from

TimeSeriesContainerVertDatum

public TimeSeriesContainerVertDatum(TimeSeriesContainer tsc,
 mil.army.usace.hec.metadata.VerticalDatumContainer vdc)
                             throws mil.army.usace.hec.metadata.VerticalDatumException

Public constructor

Parameters:

tsc - A TimeSeriesContainer object to initialize from

vdc - A VerticalDatumContainer object to initialize from

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

TimeSeriesContainerVertDatum

public TimeSeriesContainerVertDatum(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)
                             throws mil.army.usace.hec.metadata.VerticalDatumException

Public constructor

Parameters:

vdc - A VerticalDatumContainer object to initialize from

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

Method Details

clone

public Object clone()

Description copied from class: TimeSeriesContainer

clone the TimeSerieContainer

Overrides:

clone in class TimeSeriesContainer

Returns:

a copy of the TimeSeriesContainer

clone

public void clone(TimeSeriesContainer tsc)

Description copied from class: TimeSeriesContainer

clone this TimeSeriesContainer into tsc

Overrides:

clone in class TimeSeriesContainer

Parameters:

tsc - the filled in TimeSeriesContainer

getNativeVerticalDatum

public String getNativeVerticalDatum()
                              throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getNativeVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getCurrentVerticalDatum

public String getCurrentVerticalDatum()
                               throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getCurrentVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

isCurrentVerticalDatumEstimated

public boolean isCurrentVerticalDatumEstimated()
                                        throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

isCurrentVerticalDatumEstimated in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

toNativeVerticalDatum

public boolean toNativeVerticalDatum()
                              throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

toNativeVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

toNGVD29

public boolean toNGVD29()
                 throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

toNGVD29 in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

toNAVD88

public boolean toNAVD88()
                 throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

toNAVD88 in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

toVerticalDatum

public boolean toVerticalDatum(String datum)
                        throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

toVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

forceVerticalDatum

public boolean forceVerticalDatum(String datum)
                           throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

forceVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getCurrentOffset

public double getCurrentOffset()
                        throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getCurrentOffset in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getCurrentOffset

public double getCurrentOffset(String unit)
                        throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getCurrentOffset in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getNGVD29Offset

public double getNGVD29Offset()
                       throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getNGVD29Offset in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getNGVD29Offset

public double getNGVD29Offset(String unit)
                       throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getNGVD29Offset in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getNAVD88Offset

public double getNAVD88Offset()
                       throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getNAVD88Offset in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getNAVD88Offset

public double getNAVD88Offset(String unit)
                       throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getNAVD88Offset in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

isNGVD29OffsetEstimated

public boolean isNGVD29OffsetEstimated()
                                throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

isNGVD29OffsetEstimated in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

isNAVD88OffsetEstimated

public boolean isNAVD88OffsetEstimated()
                                throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

isNAVD88OffsetEstimated in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

getVerticalDatumInfo

public String getVerticalDatumInfo()
                            throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

getVerticalDatumInfo in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

setVerticalDatumInfo

public void setVerticalDatumInfo(String xmlStr)
                          throws mil.army.usace.hec.metadata.VerticalDatumException

Specified by:

setVerticalDatumInfo in interface mil.army.usace.hec.metadata.VerticalDatum

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

setVerticalDatumContainer

public void setVerticalDatumContainer(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)
                               throws mil.army.usace.hec.metadata.VerticalDatumException

Sets the VerticalDatumContainer member of this object from the specified VerticalDatumContainer

Parameters:

vdc - the VerticalDatumContainer to set this object from

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

convertVerticalDatumUnits

public void convertVerticalDatumUnits(String strUnit)

isCorrectParameter

public static boolean isCorrectParameter(String pm)

extractVerticalDatum

public mil.army.usace.hec.metadata.VerticalDatumContainer extractVerticalDatum()
                                                                        throws mil.army.usace.hec.metadata.VerticalDatumException,
IOException

Description copied from class: DataContainer

Extracts any verticalDatumInfo string in the supplementalInfo to a VerticalDatumContainer and removes the string from the supplementalInfo.

Overrides:

extractVerticalDatum in class DataContainer

Returns:

The VerticalDatumContainer

Throws:

mil.army.usace.hec.metadata.VerticalDatumException

IOException

insertVerticalDatum

public void insertVerticalDatum(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)
                         throws IOException

Description copied from class: DataContainer

Inserts the text representation a VerticalDatumContainer into the supplementalInfo field of a DataContainer object, replacing any existing vertical datum information in the field

Overrides:

insertVerticalDatum in class DataContainer

Parameters:

vdc - The VerticalDatumContainer

Throws:

IOException

getVerticalDatumContainer

public mil.army.usace.hec.metadata.VerticalDatumContainer getVerticalDatumContainer()

Returns the Vertical Datum Container

Specified by:

getVerticalDatumContainer in interface mil.army.usace.hec.metadata.VerticalDatum

Returns:

getVerticalDatumMetadata

public final Optional<mil.army.usace.hec.metadata.VerticalDatum> getVerticalDatumMetadata()

Overrides:

getVerticalDatumMetadata in class TimeSeriesContainer