Package hec.rss.model.globalvariable

Class AltTimeSeriesGlobalData

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.model.AbstractTSRecord

hec.clientapp.model.TSRecordImpl

hec.rss.model.globalvariable.AltTimeSeriesGlobalData

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, TSRecord, GlobalVariableData, Serializable, Cloneable, Comparable, Observer, mil.army.usace.hec.metadata.VerticalDatum, rma.lang.Modifiable

public class AltTimeSeriesGlobalData
extends TSRecordImpl
implements GlobalVariableData

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.clientapp.model.TSRecordImpl

_tsDataSet

Fields inherited from class hec.model.AbstractTSRecord

_beginDate, _beginTime, _compressData, _dataArray, _dssArray, _dssFilename, _dssPathname, _endTime, _inputDataPos, _interpUnitsType, _isObservedData, _numSteps, _paramName, _size, _startTime, _timeArray, _timeIncrString, _timeStepMin, _timeWindow, _units, _unitsType, _varId, _vdc, INPUT, OUTPUT

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Fields inherited from interface hec.model.TSRecord

DEFAULT_INPUT, OBS_INPUT, SUMMARY_AVG, SUMMARY_CNT, SUMMARY_MAX, SUMMARY_MIN, SUMMARY_NUMID

Constructor Summary

Constructors

Constructor	Description
AltTimeSeriesGlobalData()
AltTimeSeriesGlobalData(GlobalVariable gv)

Method Summary

Modifier and Type	Method	Description
AltTimeSeriesGlobalData	clone()	Creates a new object of the same class as this object.
boolean	copyInto(GlobalVariableData copyFromGv)	copy into this GlobalVariableData the contents from copyFromGv
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
protected boolean	finishdReadingData()	method for subclasses to override to finsih reading data
protected boolean	finishWritingData()	method for subclasses that need to do more than just the standard write data
String	getAltName()
Manager	getDataSet()
String	getDSSFilePath()
GlobalVariableDataLocation	getGlobalVariableDataLocation()
GVDataSet	getGVDataSet()
String	getRelativePath(String pathName)
GlobalVariableType	getType()
String	getValue()
int	hashCode()	Returns a hash code value for the object.
protected boolean	isInputData()	Checks if is input data.
boolean	isMarkedForDeletion()
boolean	loadData()	doesn't hold its data interally like the other GV's do
void	markForDelete(boolean markedForDelete)
protected void	parseGVRecord(String type, String param)
boolean	readData(BufferedReader input)	Read write methods for storing TSRecords to an ASCII file
boolean	readDssData(String dssFile, String dssPath)
void	setCurrentValue(int step, double value)	set the value at step
void	setGlobalVariable(GlobalVariable globalVariable)
void	setGVDataSet(GVDataSet gvDataSet)
void	setValue(Object value)
protected void	writeAdditionalInfo(BufferedWriter out)
boolean	writeData(BufferedWriter out, String alternateDssFile)
boolean	writeDssData(String alternateDssFile)

Methods inherited from class hec.clientapp.model.TSRecordImpl

checkTSData, doInterpolations, isEvapData, isValidValue, isValidValue, loadRawTSData, loadRawTSData, loadTSData, loadTSData, loadTSData, loadTSData, setTSDataSet, shouldInterpEvapData, unloadTSData, writeInterpolatedInputData, writeTSData, writeTSData, writeTSData, writeTSDataAs

Methods inherited from class hec.model.AbstractTSRecord

average, copyInto, forceVerticalDatum, getBeginDate, getBeginTime, getCumulativeTotal, getCumulativeTotal, getCurrentOffset, getCurrentOffset, getCurrentValue, getCurrentVerticalDatum, getDataArrayFor, getDSSFilename, getDSSPathname, getFieldObject, getInputDataPos, getInterpolatedTSArray, getInterpUnitsType, getLaggedValue, getNativeVerticalDatum, getNAVD88Offset, getNAVD88Offset, getNGVD29Offset, getNGVD29Offset, getNumSteps, getParamName, getPeriodAverage, getPeriodAverage, getPeriodAverage, getPeriodAverage, getPreviousValue, getSummaryArray, getTimeArray, getTimeSeriesContainer, getTimeSeriesContainerFor, getTimeStepMinutes, getTimeWindowString, getTSArray, getTSContainer, getTSValueAt, getUnits, getUnitsType, getValue, getValue, getVariableId, getVerticalDatumContainer, getVerticalDatumInfo, hasVerticalDatum, initialize, initialize, isCurrentVerticalDatumEstimated, isDefaultData, isNAVD88OffsetEstimated, isNGVD29OffsetEstimated, isObservedData, max, min, parseDssPath, readDataFromRas, reinitialize, reset, setCompressData, setCurrentValue, setDSSFilename, setDSSPathname, setDSSPathname, setFieldObject, setInputDataPos, setInterpUnitsType, setParamName, setTimeWindow, setTimeWindowString, setUnits, setUnitsType, setVariableId, setVerticalDatumContainer, setVerticalDatumInfo, shiftLeft, shiftLeft, standardDeviation, sum, toNativeVerticalDatum, toNAVD88, toNGVD29, toVerticalDatum, writeData, writeDataToRas

Methods inherited from class hec.lang.NamedType

addModifiableListener, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface hec.rss.model.globalvariable.GlobalVariableData

getDescription, getDSSFilename, getDSSPathname, getIndex, getName, setDescription, setDSSFilename, setDSSPathname, setIndex, setName

Methods inherited from interface hec.model.TSRecord

getFactor, getIndex, getName, isInput, setIndex, setInput, setName

Constructor Details

AltTimeSeriesGlobalData

public AltTimeSeriesGlobalData()

AltTimeSeriesGlobalData

public AltTimeSeriesGlobalData(GlobalVariable gv)

Method Details

getType

public GlobalVariableType getType()

Specified by:

getType in interface GlobalVariableData

getValue

public String getValue()

Specified by:

getValue in interface GlobalVariableData

setGVDataSet

public void setGVDataSet(GVDataSet gvDataSet)

Specified by:

setGVDataSet in interface GlobalVariableData

getGVDataSet

public GVDataSet getGVDataSet()

Specified by:

getGVDataSet in interface GlobalVariableData

getDSSFilePath

public String getDSSFilePath()

readData

public boolean readData(BufferedReader input)

Description copied from interface: TSRecord

Read write methods for storing TSRecords to an ASCII file

Specified by:

readData in interface GlobalVariableData

Specified by:

readData in interface TSRecord

Overrides:

readData in class AbstractTSRecord

Parameters:

input - - buffered reader to read from

Returns:

- true if successfully read

parseGVRecord

protected void parseGVRecord(String type,
 String param)

Parameters:

type -

param -

writeData

public boolean writeData(BufferedWriter out,
 String alternateDssFile)

Specified by:

writeData in interface GlobalVariableData

Parameters:

out - - buffered writer to write to

writeAdditionalInfo

protected void writeAdditionalInfo(BufferedWriter out)
                            throws IOException

Parameters:

out -

Throws:

IOException

finishWritingData

protected boolean finishWritingData()

method for subclasses that need to do more than just the standard write data

Returns:

true for success

finishdReadingData

protected boolean finishdReadingData()

method for subclasses to override to finsih reading data

Returns:

true for success

getRelativePath

public String getRelativePath(String pathName)

Overrides:

getRelativePath in class TSRecordImpl

Parameters:

pathName -

Returns:

getDataSet

public Manager getDataSet()

Overrides:

getDataSet in class TSRecordImpl

getAltName

public String getAltName()

Overrides:

getAltName in class TSRecordImpl

clone

public AltTimeSeriesGlobalData clone()

Description copied from class: NamedType

Creates a new object of the same class as this object.
It then initializes each of the new object's fields by assigning it the same value as the corresponding field in this object. No
constructor is called.

Specified by:

clone in interface GlobalVariableData

Overrides:

clone in class AbstractTSRecord

loadData

public boolean loadData()

doesn't hold its data interally like the other GV's do

Specified by:

loadData in interface GlobalVariableData

Returns:

- true if successfully loaded

writeDssData

public boolean writeDssData(String alternateDssFile)

Specified by:

writeDssData in interface GlobalVariableData

setValue

public void setValue(Object value)

Specified by:

setValue in interface GlobalVariableData

Parameters:

value - - value of this variable

getGlobalVariableDataLocation

public GlobalVariableDataLocation getGlobalVariableDataLocation()

Specified by:

getGlobalVariableDataLocation in interface GlobalVariableData

setGlobalVariable

public void setGlobalVariable(GlobalVariable globalVariable)

Specified by:

setGlobalVariable in interface GlobalVariableData

Parameters:

globalVariable - - the network global variable associated with this data

readDssData

public boolean readDssData(String dssFile,
 String dssPath)

Specified by:

readDssData in interface GlobalVariableData

isInputData

protected boolean isInputData()

Description copied from class: TSRecordImpl

Checks if is input data.

Overrides:

isInputData in class TSRecordImpl

Returns:

true, if is input data

copyInto

public boolean copyInto(GlobalVariableData copyFromGv)

Description copied from interface: GlobalVariableData

copy into this GlobalVariableData the contents from copyFromGv

Specified by:

copyInto in interface GlobalVariableData

Parameters:

copyFromGv -

markForDelete

public void markForDelete(boolean markedForDelete)

Specified by:

markForDelete in interface GlobalVariableData

isMarkedForDeletion

public boolean isMarkedForDeletion()

Specified by:

isMarkedForDeletion in interface GlobalVariableData

setCurrentValue

public void setCurrentValue(int step,
 double value)

Description copied from class: AbstractTSRecord

set the value at step

Specified by:

setCurrentValue in interface TSRecord

Overrides:

setCurrentValue in class AbstractTSRecord

Parameters:

step - the index into the data array

value - the value to set

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one. same class type and same name

Overrides:

equals in class Object

Parameters:

o - the other object

Returns:

true if they are considered equal

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

Overrides:

hashCode in class Object

Returns:

the hashcode for this object