Package hec.hecmath

Class TextMath

java.lang.Object

hec.hecmath.HecMath

hec.hecmath.TextMath

All Implemented Interfaces:

hec.heclib.dss.IHecMath, Constants

public class TextMath
extends HecMath

Field Summary

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
TextMath()
TextMath(hec.io.TextContainer tc)

Method Summary

Modifier and Type	Method	Description
boolean	canDetermineUnitSystem()
HecMath	convertToEnglishUnits()
HecMath	convertToMetricUnits()
HecMath	copy()
hec.io.TextContainer	getContainer()
hec.io.DataContainer	getData()	Copy the current DataContainer data in the HecMath object into container.
void	getData(hec.io.DataContainer container)	Copy the current DataContainer data in the HecMath object into container.
String	getText()
boolean	isEnglish()
boolean	isMetric()
void	setData(hec.io.DataContainer container)	Set the DataContainer data for the current HecMath object.
void	setText(String text)
void	setUnits(String unitsString)
String	toString()

Methods inherited from class hec.hecmath.HecMath

abs, accumulation, add, add, applyMultipleLinearRegression, bisearch, bisearch, centeredMovingAverage, checkContainer, conicInterpolation, convertToIrregular, correlationCoefficients, cos, createInstance, createInstance, cyclicAnalysis, decayingBasinWetnessParameter, divide, divide, durationAnalysis, durationAnalysis, durationAnalysis, durationAnalysis, estimateForMissingPrecipValues, estimateForMissingValues, exponentiation, extractTimeSeriesDataForTimeSpecification, flowAccumulatorGageProcessor, forwardMovingAverage, generateDataPairs, generateDataPairs, generatePairedData, generateRegularIntervalTimeSeries, generateRegularIntervalTimeSeries, generateRegularIntervalTimeSeries, getFunctionName, getPath, getSelectedCurve, getStandardUnits, getUnits, hunt, interpolateDataAtRegularInterval, inverse, isMissing, isValid, isValid, kurtosisCoefficient, lastValidDate, lastValidValue, log, log10, max, maxDate, mean, med, mergePairedDataSets, mergeTimeSeries, min, minDate, mode, modifiedPulsRouting, multipleLinearRegression, multipleRegression, multiply, multiply, muskingumRouting, numberMissingValues, numberValidValues, olympicSmoothing, p1, p10, p2, p20, p25, p5, p75, p80, p90, p95, p98, p99, periodConstants, polynomialTransformation, polynomialTransformationWithIntegral, ratingTableInterpolation, replaceSpecificValues, replaceValuesInRange, reverseRatingTableInterpolation, round, roundOff, roundOffValue, screenWithForwardMovingAverage, screenWithMaxMin, screenWithMaxMin, setCurve, setCurve, setDPart, setEPart, setLocation, setParameterPart, setPathname, setTimeInterval, setVersion, setWatershed, shiftAdjustment, shiftInTime, sin, skewCoefficient, snapToRegularInterval, sqrt, standardDeviation, standardNormalDeviate, straddleStaggerRouting, subtract, subtract, successiveDifferences, sum, tan, timeDerivative, transformTimeSeries, transformTimeSeries, transformTimeSeries, transformTimeSeries, transformWithFunction, truncate, twoVariableRatingTableInterpolation

Methods inherited from class java.lang.Object

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

Constructor Details

TextMath

public TextMath()

TextMath

public TextMath(hec.io.TextContainer tc)
         throws HecMathException

Throws:

HecMathException

Method Details

setText

public void setText(String text)
             throws HecMathException

Throws:

HecMathException

getText

public String getText()

setData

public void setData(hec.io.DataContainer container)
             throws HecMathException

Description copied from class: HecMath

Set the DataContainer data for the current HecMath object. The current HecMath will use a copy of container.

Specified by:

setData in class HecMath

Parameters:

container - The DataContainer data to be used by this HecMath object.

Throws:

HecMathException - if container is null or not the correct type of DataContainer.

getData

public void getData(hec.io.DataContainer container)
             throws HecMathException

Description copied from class: HecMath

Copy the current DataContainer data in the HecMath object into container.

Specified by:

getData in class HecMath

Parameters:

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

Throws:

HecMathException

getData

public hec.io.DataContainer getData()
                             throws HecMathException

Description copied from class: HecMath

Copy the current DataContainer data in the HecMath object into container.

Specified by:

getData in interface hec.heclib.dss.IHecMath

Specified by:

getData in class HecMath

Returns:

a copy of the DataContainer held in the current HecMath object.

Throws:

HecMathException

getContainer

public hec.io.TextContainer getContainer()

toString

public String toString()

Overrides:

toString in class Object

convertToEnglishUnits

public HecMath convertToEnglishUnits()
                              throws HecMathException

Specified by:

convertToEnglishUnits in class HecMath

Throws:

HecMathException

convertToMetricUnits

public HecMath convertToMetricUnits()
                             throws HecMathException

Specified by:

convertToMetricUnits in class HecMath

Throws:

HecMathException

isMetric

public boolean isMetric()
                 throws HecMathException

Specified by:

isMetric in class HecMath

Throws:

HecMathException

isEnglish

public boolean isEnglish()
                  throws HecMathException

Specified by:

isEnglish in class HecMath

Throws:

HecMathException

canDetermineUnitSystem

public boolean canDetermineUnitSystem()

Specified by:

canDetermineUnitSystem in class HecMath

setUnits

public void setUnits(String unitsString)

Specified by:

setUnits in class HecMath

copy

public HecMath copy()
             throws HecMathException

Specified by:

copy in class HecMath

Throws:

HecMathException