Package hec.rss.model

Class TimeSeries

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.rss.model.RssTSLocationObject

hec.rss.model.Rule

hec.rss.model.TimeSeries

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, TSLocation, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable

public class TimeSeries
extends Rule
implements TSLocation

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	FORECAST_DIV

Fields inherited from class hec.rss.model.Rule

_multiplier, _opController, _ruleType, _timeOfDayMultiplier, _useDayOfWeekMultiplier, _usePeriodAverageLimit, _useTimeOfDayMultiplier

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.rss.model.RssModelVariableConstants

CUMLOC_OUTPUT_DATA, GRPID_DIVERSION, GRPID_JUNCTION, GRPID_REACH, GRPID_RESERVOIR, HINDCAST_IDS, HOLDOUT_OUTPUT_DATA, INPUT_DATA, OUTPUT_DATA, PULSE_OUTPUT_DATA, UNREG_OUTPUT_DATA, VID_ADJPARAM_FLOW, VID_CAPACITY_FACTOR, VID_CTRLOUT_HINDFLW, VID_CTRLOUT_RELEASE, VID_DAM_LEAK, VID_DAM_RELEASE, VID_DIV_FLOW, VID_DIV_FLOW_ROUTED, VID_DIV_HINDFLW, VID_DIV_RELEASE, VID_DIVOUT_FLOW, VID_DIVOUT_FLOW_ROUTED, VID_ENERGYREQUIRED_TSINPUT, VID_FIRST, VID_FOREBAY_ELEV, VID_FOREBAY_HEADLOSS, VID_GATE_OPENING, VID_GATE_PERCENTOPEN, VID_JUNC_ELEV, VID_JUNC_FLOW_CUMLOC, VID_JUNC_FLOW_DIV, VID_JUNC_FLOW_HOLD, VID_JUNC_FLOW_IN, VID_JUNC_FLOW_LIMIT, VID_JUNC_FLOW_LOCAL, VID_JUNC_FLOW_PULSE, VID_JUNC_FLOW_REG, VID_JUNC_FLOW_UNREG, VID_JUNC_FLOW_VIOL, VID_JUNC_HINDFLOW, VID_JUNC_INFLOW, VID_JUNC_INFLOW_LOCAL_TOTAL, VID_JUNC_STAGE, VID_JUNC_STAGE_LIMIT, VID_JUNC_STAGE_REG, VID_JUNC_STAGE_UNREG, VID_JUNC_STAGE_VIOL, VID_LAST, VID_NODE_FLOW, VID_NODE_HINDFLW, VID_NODE_HINDSTG, VID_NODE_KNOWNFLOW, VID_NODE_STAGE, VID_OPCTRL_CONSTRAINTID, VID_OPCTRL_DECISION, VID_OPCTRL_MAXLIMIT, VID_OPCTRL_MINLIMIT, VID_OPCTRL_RULEID, VID_OPCTRL_ZONEID, VID_OPRULE_FLOW_SPACE, VID_OPRULE_MAX, VID_OPRULE_MAX_STAGE, VID_OPRULE_MIN, VID_OPRULE_MIN_STAGE, VID_OPRULE_PRIORITY, VID_OPRULE_ROUTE_LAG, VID_OPRULE_ROUTE_MAXOFFSET, VID_OPRULE_ROUTE_MINOFFSET, VID_OPRULE_SPEC, VID_OPRULE_STOR_BAL, VID_OPRULE_STOR_BAL_INDEX, VID_OPRULE_VIOL_ELEV, VID_OPRULE_VIOL_FLOW, VID_OPRULE_VIOL_STAGE, VID_OPRULE_VIOL_STOR, VID_OPRULE_WQCD_ELEV, VID_OPRULEFL_CUMLOC, VID_OPRULETS_TSINPUT, VID_OPSET_ACTIVEZONE, VID_OPSET_GC_ELEV, VID_OPSET_GC_STOR, VID_OPSET_KNOWNZONEELEV, VID_OPSET_PROJECTEDELEV, VID_OPSET_ZONEELEV, VID_OPSET_ZONESTOR, VID_OUTGRP_RELEASE, VID_POOL_AREA, VID_POOL_ELEV, VID_POOL_ELEV_EST, VID_POOL_ELEVROC, VID_POOL_EVAP, VID_POOL_FLOWINTOSTOR, VID_POOL_HINDELEV, VID_POOL_HINDSTOR, VID_POOL_HOLDOUT, VID_POOL_INFLOW, VID_POOL_INPUTEVAP, VID_POOL_NETINFLOW, VID_POOL_OUTFLOW, VID_POOL_OUTFLOW_EST, VID_POOL_SEEP, VID_POOL_STOR, VID_PULSE_BACKQ, VID_PULSE_PULSEQ, VID_PUMP_FLOWAVG, VID_PUMP_VOL, VID_PUMPRULE_FLOWAVG, VID_PUMPRULE_FLOWAVG_CAP, VID_PUMPRULE_FLOWINST, VID_PUMPRULE_FLOWINST_CAP, VID_PUMPRULE_HOURS, VID_PUMPRULE_HOURS_CAP, VID_PUMPRULE_NUMPUMP, VID_PUMPRULE_NUMPUMP_CAP, VID_PUMPRULE_UNITHOURS, VID_PUMPRULE_UNITHOURS_CAP, VID_PUMPRULE_VOL, VID_PUMPRULE_VOL_CAP, VID_PWR_CAPABILITY, VID_PWR_EFF, VID_PWR_ENGYGEN, VID_PWR_ENGYPATTERN, VID_PWR_ENGYPERGEN, VID_PWR_ENGYPERREQD, VID_PWR_ENGYREQD, VID_PWR_ENGYVIOL, VID_PWR_FLWPWR, VID_PWR_HDPWR, VID_PWR_HYDLSS, VID_PWR_MAXCAPACITY, VID_PWR_PER_BALGEN, VID_PWR_PER_GCGEN, VID_PWR_PER_MINPUMPGEN, VID_PWR_PER_MINRELGEN, VID_PWR_PER_POWGEN, VID_PWR_PER_PUMPGEN, VID_PWR_PLNTFAC, VID_PWR_PWRCAP, VID_PWR_REQUIRED, VID_PWR_SPILL, VID_PWR_VIOL, VID_RCH_SEEP, VID_REACH_FLOW_CUMLOC, VID_REACH_FLOW_IN, VID_REACH_FLOW_REG, VID_REACH_FLOW_UNREG, VID_RES_GCRELEASE, VID_RES_HOLDOUT, VID_RES_RELEASE, VID_SPILL_FLOW, VID_SPILL_HINDFLOW, VID_STATE_VAR, VID_STATE_VAR_HIND, VID_TAIL_ELEV, VID_UNCTOUT_FLOW, VID_UNCTOUT_HINDFLW, VID_WA_ACCOUNT_DEMAND, VID_WA_ACCOUNT_INFLOW, VID_WA_CHARGES, VID_WA_CREDIT, VID_WA_CURRENT_MAX_VOLUME, VID_WA_CURRENT_VOLUME, VID_WA_HINDSTOR, VID_WA_LOSSES, VID_WA_PUMPBACK, VID_WA_RULE_DEMAND, VID_WA_SURPLUS, VID_WA_TRANSFERS, WQID_OFFSET

Fields inherited from interface hec.rss.model.RssReturnStatusConstants

RTN_CANCELED, RTN_NOPROBLEM, RTN_OPCHANGE, RTN_PROBLEM

Constructor Summary

Constructors

Constructor	Description
TimeSeries()
TimeSeries(Controller control)	Deprecated.
TimeSeries(OpController controller)

Method Summary

Modifier and Type	Method	Description
TSRecordProxy	addTSRecord(String name, String param, boolean isinput)	adds a TSRecordProxy to this function by name, parameter, and input/output flag
TSRecordProxy	addTSRecordProxy(String name, int varId)	Adds a TSRecordProxy by model variable Id
Vector	getActiveTSRecordProxies(Vector vec, int iotype)	add the time series record proxies associated current compute
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
doubleArrayContainer	getTSContainer(int vid)	returns the double array containing the time series of the record according to variable id.
TSDataSet	getTSDataSet(boolean isInput)	returns the TSDataSet that holds TSRecords for current input and output
Vector	getTSRecordProxies()
TSRecordProxy	getTSRecordProxy(String name, int varId)	finds a TSRecordProxy for the given variable id and name in this TSLocation
double	getValue(AdjustableParameter adjparam, RunTimeStep runtime, double val)	This method should be overriden
boolean	initialize()
boolean	readData(BufferedReader input)
void	removeTSRecord(String name, String param, boolean isinput)
void	setDiversionName(String name)
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
void	updateTSProxyList()	Regenerates the list of all TSProxies required for this location.
boolean	writeData(BufferedWriter out)

Methods inherited from class hec.rss.model.Rule

getController, getDayOfWeekFactor, getDemandScale, getGmtOffset, getMultiplier, getReferencedStateVariables, getRuleType, getSystem, getTimeOfDayFactor, getTimeOfDayMultiplier, getUnitSystem, initializeCompute, setController, setDemandScale, setMultiplier, setOpController, setPeriodAverageLimit, setRuleType, setTimeOfDayMultiplier, setTSLocationData, setUseDayOfWeekMultiplier, setUseDemandScale, setUsePeriodAverageLimit, setUseTimeOfDayMultiplier, toString, updateByDemandScale, useDayOfWeekMultiplier, useDemandScale, usePeriodAverageLimit, useTimeOfDayMultiplier

Methods inherited from class hec.rss.model.RssTSLocationObject

addTSRecordProxy, addTSRecordProxy, clearTSProxyList, clone, copyInto, getComputedTSRecordProxies, getTSArray, getTSArray, getTSArray, getTSArray, getTSContainer, getTSRecordProxy, getTSRecordProxy, getTSRecordProxy, getTSRecordProxy, getTSRecordProxyVec, removeTSRecord, removeTSRecordProxy, removeTSRecordProxy

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, 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

Field Details

FORECAST_DIV

public static String FORECAST_DIV

Constructor Details

TimeSeries

public TimeSeries()

TimeSeries

@Deprecated
public TimeSeries(Controller control)

Deprecated.

TimeSeries

public TimeSeries(OpController controller)

Method Details

setDiversionName

public void setDiversionName(String name)

initialize

public boolean initialize()

Overrides:

initialize in class Rule

getValue

public double getValue(AdjustableParameter adjparam,
 RunTimeStep runtime,
 double val)

Description copied from class: Rule

This method should be overriden

Specified by:

getValue in class Rule

writeData

public boolean writeData(BufferedWriter out)

Overrides:

writeData in class Rule

readData

public boolean readData(BufferedReader input)

Overrides:

readData in class Rule

updateTSProxyList

public void updateTSProxyList()

Regenerates the list of all TSProxies required for this location. This list includes all records that are generated by this function even if the records are held in another objects (e.g. RssNode) proxy list

Overrides:

updateTSProxyList in class Rule

getActiveTSRecordProxies

public Vector getActiveTSRecordProxies(Vector vec,
 int iotype)

add the time series record proxies associated current compute

Overrides:

getActiveTSRecordProxies in class Rule

addTSRecordProxy

public TSRecordProxy addTSRecordProxy(String name,
 int varId)

Adds a TSRecordProxy by model variable Id

Overrides:

addTSRecordProxy in class RssTSLocationObject

addTSRecord

public TSRecordProxy addTSRecord(String name,
 String param,
 boolean isinput)

Description copied from class: RssTSLocationObject

adds a TSRecordProxy to this function by name, parameter, and input/output flag

Overrides:

addTSRecord in class RssTSLocationObject

removeTSRecord

public void removeTSRecord(String name,
 String param,
 boolean isinput)

getTSContainer

public doubleArrayContainer getTSContainer(int vid)

returns the double array containing the time series of the record according to variable id. returns null if unsuccessful

Overrides:

getTSContainer in class RssTSLocationObject

getTSRecordProxy

public TSRecordProxy getTSRecordProxy(String name,
 int varId)

finds a TSRecordProxy for the given variable id and name in this TSLocation

Overrides:

getTSRecordProxy in class RssTSLocationObject

getTSRecordProxies

public Vector getTSRecordProxies()

Overrides:

getTSRecordProxies in class Rule

getTSDataSet

public TSDataSet getTSDataSet(boolean isInput)

Description copied from class: RssTSLocationObject

returns the TSDataSet that holds TSRecords for current input and output

Specified by:

getTSDataSet in interface TSLocation

Overrides:

getTSDataSet in class RssTSLocationObject

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 Rule

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 Rule

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