Package hec.rss.model.globalvariable

Class TimeSeriesGlobalVariable

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.model.AbstractTSRecord

hec.clientapp.model.TSRecordImpl

hec.clientapp.model.TSRecordProxy

hec.rss.model.globalvariable.TimeSeriesGlobalVariable

All Implemented Interfaces:

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

public class TimeSeriesGlobalVariable
extends TSRecordProxy
implements GlobalVariable

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.clientapp.model.TSRecordProxy

_tsRecord

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
TimeSeriesGlobalVariable()
TimeSeriesGlobalVariable(RssSystem network)

Method Summary

Modifier and Type	Method	Description
TimeSeriesGlobalVariable	clone()	Creates a new object of the same class as this object.
void	finalizeCompute()	called at the end of the compute to do any compute related cleanup that's necessary;
String	getDescriptiveText()	gets a description of the type of the global variable
String	getDSSFilename()	get the DSS File for the Global Variable
String	getDSSPathname()	get the DSS Path for the Global Variable
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
int	getIndex()	Return the index of the NamedType as an int.
boolean	getIsDataLocation()
RssSystem	getNetwork()	get the GlobalVariable's Network
String	getParameter()
String	getParameterType()
TimeSeriesContainer	getTimeSeriesContainer()	Get the TimeSeriesContainer for the GlobalVariable.
TimeSeriesContainer	getTimeSeriesContainerFor(int step, int period)	Creates a TimeSeriesContainer filled with data from the GlobalVariable starting at "step" and going forward, if period is positive, or backwards, if period is negative.
TimeStepType	getTimeStepType()
TSRecord	getTSRecord()
GlobalVariableType	getType()
String	getUsageType()
String	hasValidValue()	check to see if the GlobalVariable has a valid value
boolean	initializeGv()
boolean	isInput()
void	outputReport(AlternativeInputReport report, org.jdom.Element myElem)	add the Time Series Global Variables information to the alternative report
void	setCurrentValue(int step, double value)	set the value at step
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
void	setGlobalVariableData(GlobalVariableData altGvData)
void	setIndex(int index)
void	setInput(boolean isInput)
void	setIsDataLocation(boolean isDataLocation)
void	setParameter(String parameter)
void	setParameterType(String parameterType)
void	setTimeStepType(TimeStepType timeStepType)

Methods inherited from class hec.clientapp.model.TSRecordProxy

getDefaultPath, getFactor, getFullName, getParent, getTimeArray, getTimeSeriesDescription, getTSArray, getTSContainer, initialize, isDataFeedAlive, readData, reset, setDataFeedAlive, setDefaultPath, setFactor, setFullName, setName, setParent, setTimeSeriesDescription, setTSDataSet, toString, unload

Methods inherited from class hec.clientapp.model.TSRecordImpl

checkTSData, doInterpolations, getAltName, getDataSet, getRelativePath, isEvapData, isInputData, 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, getInputDataPos, getInterpolatedTSArray, getInterpUnitsType, getLaggedValue, getNativeVerticalDatum, getNAVD88Offset, getNAVD88Offset, getNGVD29Offset, getNGVD29Offset, getNumSteps, getParamName, getPeriodAverage, getPeriodAverage, getPeriodAverage, getPeriodAverage, getPreviousValue, getSummaryArray, getTimeStepMinutes, getTimeWindowString, getTSValueAt, getUnits, getUnitsType, getValue, getValue, getVariableId, getVerticalDatumContainer, getVerticalDatumInfo, hasVerticalDatum, initialize, initialize, isCurrentVerticalDatumEstimated, isDefaultData, isNAVD88OffsetEstimated, isNGVD29OffsetEstimated, isObservedData, max, min, parseDssPath, readDataFromRas, reinitialize, setCompressData, setCurrentValue, setDSSFilename, setDSSPathname, setDSSPathname, 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, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setModified, setName, setValid, 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

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

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

getDescription, getName, setDescription, setName

Methods inherited from interface hec.model.TSRecord

getName, setName

Constructor Details

TimeSeriesGlobalVariable

public TimeSeriesGlobalVariable()

TimeSeriesGlobalVariable

public TimeSeriesGlobalVariable(RssSystem network)

Method Details

clone

public TimeSeriesGlobalVariable 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 GlobalVariable

Overrides:

clone in class TSRecordProxy

getType

public GlobalVariableType getType()

Specified by:

getType in interface GlobalVariable

getParameter

public String getParameter()

setParameter

public void setParameter(String parameter)

getTimeStepType

public TimeStepType getTimeStepType()

setTimeStepType

public void setTimeStepType(TimeStepType timeStepType)

getParameterType

public String getParameterType()

setParameterType

public void setParameterType(String parameterType)

setIndex

public void setIndex(int index)

Specified by:

setIndex in interface GlobalVariable

Specified by:

setIndex in interface TSRecord

Overrides:

setIndex in class NamedType

getIndex

public int getIndex()

Description copied from class: NamedType

Return the index of the NamedType as an int.

Specified by:

getIndex in interface GlobalVariable

Specified by:

getIndex in interface TSRecord

Overrides:

getIndex in class NamedType

isInput

public boolean isInput()

Specified by:

isInput in interface GlobalVariable

Specified by:

isInput in interface TSRecord

Overrides:

isInput in class TSRecordProxy

Returns:

setInput

public void setInput(boolean isInput)

Specified by:

setInput in interface GlobalVariable

Specified by:

setInput in interface TSRecord

Overrides:

setInput in class TSRecordProxy

getUsageType

public String getUsageType()

Returns:

initializeGv

public boolean initializeGv()

Specified by:

initializeGv in interface GlobalVariable

getDescriptiveText

public String getDescriptiveText()

Description copied from interface: GlobalVariable

gets a description of the type of the global variable

Specified by:

getDescriptiveText in interface GlobalVariable

Returns:

descriptive text

setGlobalVariableData

public void setGlobalVariableData(GlobalVariableData altGvData)

Specified by:

setGlobalVariableData in interface GlobalVariable

finalizeCompute

public void finalizeCompute()

Description copied from interface: GlobalVariable

called at the end of the compute to do any compute related cleanup that's necessary;

Specified by:

finalizeCompute in interface GlobalVariable

getNetwork

public RssSystem getNetwork()

get the GlobalVariable's Network

Specified by:

getNetwork in interface GlobalVariable

Returns:

the GlobalVariable's network

getTSRecord

public TSRecord getTSRecord()

Overrides:

getTSRecord in class TSRecordProxy

getDSSFilename

public String getDSSFilename()

get the DSS File for the Global Variable

Specified by:

getDSSFilename in interface TSRecord

Overrides:

getDSSFilename in class AbstractTSRecord

Returns:

the DSS File or null

getDSSPathname

public String getDSSPathname()

get the DSS Path for the Global Variable

Specified by:

getDSSPathname in interface TSRecord

Overrides:

getDSSPathname in class AbstractTSRecord

Returns:

the DSS Path or null

getTimeSeriesContainer

public TimeSeriesContainer getTimeSeriesContainer()

Get the TimeSeriesContainer for the GlobalVariable. The TimeSeriesContainer will have no quality.

Specified by:

getTimeSeriesContainer in interface TSRecord

Overrides:

getTimeSeriesContainer in class AbstractTSRecord

Returns:

The GlobalVariable's TimeSeriesContainer or null if the GlobalVariable failed to load its data or its initialization failed

getTimeSeriesContainerFor

public TimeSeriesContainer getTimeSeriesContainerFor(int step,
 int period)

Creates a TimeSeriesContainer filled with data from the GlobalVariable starting at "step" and going forward, if period is positive, or backwards, if period is negative.

Specified by:

getTimeSeriesContainerFor in interface TSRecord

Overrides:

getTimeSeriesContainerFor in class AbstractTSRecord

Parameters:

step - , the starting step

period - , the number of steps to go back when a negative number or forward if a positive number

int - step, the starting step

int - period, the number of steps to go back when a negative number or forward if a positive number

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Overrides:

getFieldObject in class TSRecordProxy

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Overrides:

setFieldObject in class TSRecordProxy

Parameters:

fld - The java field object representing the member field to be set

fobj - The data to set in that field

Returns:

returns true if successful

hasValidValue

public String hasValidValue()

Description copied from interface: GlobalVariable

check to see if the GlobalVariable has a valid value

Specified by:

hasValidValue in interface GlobalVariable

Returns:

null if valid, message string if its not.

setIsDataLocation

public void setIsDataLocation(boolean isDataLocation)

Specified by:

setIsDataLocation in interface GlobalVariable

getIsDataLocation

public boolean getIsDataLocation()

Specified by:

getIsDataLocation in interface GlobalVariable

outputReport

public void outputReport(AlternativeInputReport report,
 org.jdom.Element myElem)

add the Time Series Global Variables information to the alternative report

Specified by:

outputReport in interface GlobalVariable

Parameters:

report - the alternative report

myElem - the element to add the information to

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