Package hec.hecmath

Class TimeSeriesMathVertDatum

java.lang.Object

hec.hecmath.HecMath

hec.hecmath.TimeSeriesMath

hec.hecmath.TimeSeriesMathVertDatum

All Implemented Interfaces:

IVerticalDatumOperations<TimeSeriesMath,HecMathException>, Constants, mil.army.usace.hec.metadata.VerticalDatum

public class TimeSeriesMathVertDatum
extends TimeSeriesMath
implements mil.army.usace.hec.metadata.VerticalDatum

Field Summary

Fields inherited from class hec.hecmath.TimeSeriesMath

ACCUMULATE, AVERAGE, COUNT_VALID, INST, INST_CUM, INST_VAL, INTEGRATE, INTERPOLATE, LEVEL_DAYMONTH_STRING, LEVEL_DAYWEEK_STRING, LEVEL_MONTH_STRING, LEVEL_TIME_STRING, LEVEL_YEAR_STRING, MAX, MIN, PER_AVER, PER_CUM, TYPE_UNDEFINED, VOLUME

Fields inherited from class hec.hecmath.HecMath

_curveNumber, _dc, _dssPath, ABS, ADD, COS, DIVIDE, EXPONENTIATION, INVERSE, LOG, LOG10, MULTIPLY, ROUND, SIN, SQRT, SUBTRACT, TAN, TRUNCATE

Fields inherited from interface hec.script.Constants

FALSE, ITS_DELETE_INSERT, ITS_MERGE, RTS_REPLACE_ALL, RTS_REPLACE_ALL_CREATE, RTS_REPLACE_ALL_DELETE, RTS_REPLACE_MISSING_VALUES_ONLY, RTS_REPLACE_WITH_NON_MISSING, TRUE, UNDEFINED, UNDEFINED_DOUBLE, UNDEFINED_FLOAT, UNDEFINED_INT, UNDEFINED_LONG, UNDEFINED_TIME

Constructor Summary

Constructors

Constructor	Description
TimeSeriesMathVertDatum()
TimeSeriesMathVertDatum(TimeSeriesContainer tsc)

Method Summary

Modifier and Type	Method	Description
HecMath	copy()	Create a duplicate copy of the time series object.
boolean	forceVerticalDatum(String datum)
double	getCurrentOffset()
double	getCurrentOffset(String unit)
String	getCurrentVerticalDatum()
DataContainer	getData()	Copy the current TimeSeriesContainer data in the TimeSeriesMath object into container.
void	getData(DataContainer container)	Copy the current TimeSeriesContainer data in the TimeSeriesMath object into container.
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 form the Data Container
String	getVerticalDatumInfo()
boolean	isCurrentVerticalDatumEstimated()
boolean	isNAVD88OffsetEstimated()
boolean	isNGVD29OffsetEstimated()
void	setData(DataContainer container)	Set the TimeSeriesContainer data for the current TimeSeriesMath object.
void	setVerticalDatumContainer(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)	Sets the VerticalDatumContainer on the data container
void	setVerticalDatumInfo(String xmlStr)
boolean	toNativeVerticalDatum()
boolean	toNAVD88()
boolean	toNGVD29()
boolean	toVerticalDatum(String datum)

Methods inherited from class hec.hecmath.TimeSeriesMath

abs, accumulation, acos, add, add, asin, atan, canDetermineUnitSystem, ceil, centeredMovingAverage, checkTimeSeries, checkTimeSeriesMatch, checkTimeSeriesMath, collapseVerticalDatum, computeDurationAnalysis, computeSimpleFrequency, convertToEnglishUnits, convertToIrregular, convertToIrregular, convertToMetricUnits, copyHeaderInfo, correlationCoefficients, cos, cyclicAnalysis, cyclicAnalysis, decayingBasinWetnessParameter, divide, divide, durationAnalysisBin, durationAnalysisStandard, estimateForMissingPrecipValues, estimateForMissingValues, exp, expandVerticalDatum, exponentiation, exponentiation, extractTimeSeriesDataForTimeSpecification, findInterval, findValidValue, firstValidDate, firstValidValue, floor, flowAccumulatorGageProcessor, fmod, fmod, forwardMovingAverage, forwardMovingAverage, generateDataPairs, generateDataPairs, generatePairedData, generateRegularIntervalTimeSeries, generateRegularIntervalTimeSeries, generateRegularIntervalTimeSeries, getContainer, getFunctionType, getSortedPeaks, getStandardUnits, getType, getUnits, gmean, hmean, integer_divide, integer_divide, integerDivide, integerDivide, interpolateDataAtRegularInterval, inverse, isEnglish, isMetric, isMuskingumRoutingStable, isValid, isValid, kurtosisCoefficient, lastValidDate, lastValidValue, log, log10, max, max, maxDate, mean, mean, med, med, mergeTimeSeries, min, min, minDate, mode, modulo, modulo, multipleRegression, multiply, multiply, muskingumRouting, neg, negative, numberInvalidValues, numberMissingValues, numberQuestionedValues, numberRejectedValues, numberValidValues, olympicSmoothing, p1, p1, p10, p10, p2, p2, p20, p20, p25, p25, p5, p5, p75, p75, p80, p80, p90, p90, p95, p95, p98, p98, p99, p99, params, periodConstants, product, replaceSpecificValues, replaceValuesInRange, resample, rms, round, roundOff, screenWithConstantValue, screenWithDurationMagnitude, screenWithForwardMovingAverage, screenWithForwardMovingAverage, screenWithMaxMin, screenWithMaxMin, screenWithMaxMin, screenWithMaxMin, screenWithRateOfChange, setParameterPart, setType, setUnits, shiftAdjustment, shiftInTime, shiftInTime, shiftInTime, shiftInTime, sign, sin, skewCoefficient, snapToRegularInterval, sqrt, standardDeviation, standardDeviation, stddev, straddleStaggerRouting, subtract, subtract, successiveDifferences, sum, sum, tan, timeDerivative, transformTimeSeries, transformTimeSeries, transformTimeSeries, transformTimeSeries, transformTimeSeries, transformWithFunction, truncate, var, variance

Methods inherited from class hec.hecmath.HecMath

applyMultipleLinearRegression, bisearch, bisearch, checkContainer, conicInterpolation, createInstance, createInstance, durationAnalysis, durationAnalysis, durationAnalysis, durationAnalysis, getFunctionName, getPath, getSelectedCurve, hunt, isMissing, isValid, mergePairedDataSets, modifiedPulsRouting, multipleLinearRegression, polynomialTransformation, polynomialTransformationWithIntegral, ratingTableInterpolation, reverseRatingTableInterpolation, roundOffValue, setCurve, setCurve, setDPart, setEPart, setLocation, setPathname, setTimeInterval, setVersion, setWatershed, standardNormalDeviate, twoVariableRatingTableInterpolation

Methods inherited from class java.lang.Object

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

Constructor Details

TimeSeriesMathVertDatum

public TimeSeriesMathVertDatum()

TimeSeriesMathVertDatum

public TimeSeriesMathVertDatum(TimeSeriesContainer tsc)
                        throws HecMathException

Throws:

HecMathException

Method Details

setData

public void setData(DataContainer container)
             throws HecMathException

Description copied from class: TimeSeriesMath

Set the TimeSeriesContainer data for the current TimeSeriesMath object. The current TimeSeriesMath will use a copy of container.

Overrides:

setData in class TimeSeriesMath

Parameters:

container - the TimeSeriesContainer data to be used by this TimeSeriesMath object.

Throws:

HecMathException - if container is null or not of type TimeSeriesContainer.

getData

public DataContainer getData()
                      throws HecMathException

Description copied from class: TimeSeriesMath

Copy the current TimeSeriesContainer data in the TimeSeriesMath object into container.

Overrides:

getData in class TimeSeriesMath

Returns:

a copy of the TimeSeriesContainer held in the current TimeSeriesMath object.

Throws:

HecMathException

getData

public void getData(DataContainer container)
             throws HecMathException

Description copied from class: TimeSeriesMath

Copy the current TimeSeriesContainer data in the TimeSeriesMath object into container.

Overrides:

getData in class TimeSeriesMath

Parameters:

container - the TimeSeriesContainer to receive the copy of data from this time series.

Throws:

HecMathException

copy

public HecMath copy()
             throws HecMathException

Description copied from class: TimeSeriesMath

Create a duplicate copy of the time series object.

Overrides:

copy in class TimeSeriesMath

Returns:

a duplicate copy of the time series

Throws:

HecMathException

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

getVerticalDatumContainer

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

Returns the Vertical Datum Container form the Data Container

Specified by:

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

Returns:

setVerticalDatumContainer

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

Sets the VerticalDatumContainer on the data container

Parameters:

vdc - the VerticalDatumContainer to set this object from

Throws:

mil.army.usace.hec.metadata.VerticalDatumException