Package hec.rss.model

Class TandemOpRule

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.rss.model.RssTSLocationObject

hec.rss.model.OpRule

hec.rss.model.TandemOpRule

All Implemented Interfaces:

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

public class TandemOpRule
extends OpRule
implements DemandRuleInf

Title: General CWMS Project Description: Copyright: Copyright (c) 2000 Company: RMA

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.rss.model.OpRule

_avgPeriod, _enableRiseFallCond, _multiplier, _parameterType, _riseFallCondition, _riseFallTolerance, _system, _timeOfDayMultiplier, _useDayOfWeekMultiplier, _usePeriodAverageLimit, _useTimeOfDayMultiplier, FALLING, FALLING_OR_CONST, INFLOW, NONE, POOL_ELEVATION, RISING, RISING_OR_CONST, RULETYPE_DEMAND, RULETYPE_FREE, RULETYPE_MAX, RULETYPE_MIN, RULETYPE_SPEC

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
TandemOpRule()	default constructor
TandemOpRule(String name)	constructor that accepts a rule name

Method Summary

Modifier and Type	Method	Description
void	evaluateLimits(RunTimeStep rts, int iteration)	do nothing
OpValue	evaluateRule(RunTimeStep rts, double initialValue, int iteration, boolean evalDownstream)	compares the intial value to rule constraints and returns the adjusted value
Vector	getActiveTSRecordProxies(Vector vec, int iotype)	add the time series record proxies associated current compute
void	getElementDependencies(List elemList)	adds elements upon which the current rule depends to the given list.
OpValue	getOpValue(RunTimeStep rts)	returns the operation value based on the previously computed rule limit.
int	getReservoirIndex()	accessor method that returns the reservoir index
int	getRuleLimitType()	get the limit type of this rule should be implemented by all subclasses of OpRule
ReservoirElement	getTandemReservoir()	returns the downstream Reservoir for which this rule operates.
WaterAccount	getWaterAccount()	Gets the water account.
boolean	initializeCompute()	called at the begining of the computation
boolean	isDnstrmRule()	returns true if this rule is a downstream rule
boolean	isLocalRule()	returns true if this rule is local to a reservoir
boolean	isPerAvgRule()	returns true if this rule uses period average evaluation
void	outputReport(AlternativeInputReport report, org.jdom.Element elem)	Alternative Input Report Interface for data.
void	setBalanceStor(RunTimeStep rts, double balstor, double releaseVol)
void	setReservoirIndex(int resIndex)	accessor method to set the reservoir index
void	setRuleLimit(RunTimeStep rts, double limitval)
void	setWaterAccount(WaterAccount wa)	Sets the water account.
void	updateTSProxyList()	Regenerates the list of all TSProxies required for this location.

Methods inherited from class hec.rss.model.OpRule

applyHindcastData, checkRisingFallingCondition, clone, computeStepLimit, evaluateRule, evaluateRule, evaulatePerformance, getAveragingPeriod, getController, getDayOfWeekFactor, getDemandScale, getEnableRiseFallCondition, getFieldObject, getGmtOffset, getKeyStringForObject, getLargestDayOfWeekFactor, getLargestTimeOfDayFactor, getMultiplier, getNetwork, getObjectForKeyString, getOperationsElement, getParameterType, getPowerOpValue, getPriority, getReferencedStateVariables, getRequiredTSRecordProxies, getReservoirElement, getRiseFallCondition, getRiseFallTolerance, getRssSystem, getSystem, getTargetTSRecordProxy, getTimeOfDayFactor, getTimeOfDayMultiplier, getTSProxyName, getUnitSystem, initForPostProcessing, initOperationStep, isActive, resetChildOwnership, restoreFunctionState, restoreHotstartState, riseFallConditionIsValid, saveFunctionState, saveHotstartState, setAveragingPeriod, setController, setDemandScale, setEnableRiseFallCondition, setFieldObject, setMultiplier, setParameterType, setPeriodAverageLimit, setPriority, setRiseFallCondition, setRiseFallTolerance, setSystem, setTimeOfDayMultiplier, setUseDayOfWeekMultiplier, setUseDemandScale, setUsePeriodAverageLimit, setUseTimeOfDayMultiplier, toString, updateByDemandScale, useDayOfWeekMultiplier, useDemandScale, usePeriodAverageLimit, useTimeOfDayMultiplier

Methods inherited from class hec.rss.model.RssTSLocationObject

addTSRecord, addTSRecordProxy, addTSRecordProxy, addTSRecordProxy, clearTSProxyList, copyInto, getComputedTSRecordProxies, getTSArray, getTSArray, getTSArray, getTSArray, getTSContainer, getTSContainer, getTSDataSet, getTSRecordProxies, getTSRecordProxy, 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

Constructor Details

TandemOpRule

public TandemOpRule()

default constructor

TandemOpRule

public TandemOpRule(String name)

constructor that accepts a rule name

Parameters:

name -

Method Details

getElementDependencies

public void getElementDependencies(List elemList)

adds elements upon which the current rule depends to the given list. Does not add the element that owns this rule.

Overrides:

getElementDependencies in class OpRule

getActiveTSRecordProxies

public Vector getActiveTSRecordProxies(Vector vec,
 int iotype)

add the time series record proxies associated current compute

Overrides:

getActiveTSRecordProxies in class OpRule

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 OpRule

evaluateLimits

public void evaluateLimits(RunTimeStep rts,
 int iteration)

do nothing

Overrides:

evaluateLimits in class OpRule

Parameters:

rts -

iteration -

setBalanceStor

public void setBalanceStor(RunTimeStep rts,
 double balstor,
 double releaseVol)

setRuleLimit

public void setRuleLimit(RunTimeStep rts,
 double limitval)

getOpValue

public OpValue getOpValue(RunTimeStep rts)

returns the operation value based on the previously computed rule limit. As of 12/04

Overrides:

getOpValue in class OpRule

Parameters:

rts -

Returns:

isLocalRule

public boolean isLocalRule()

returns true if this rule is local to a reservoir

Overrides:

isLocalRule in class OpRule

Returns:

isDnstrmRule

public boolean isDnstrmRule()

returns true if this rule is a downstream rule

Overrides:

isDnstrmRule in class OpRule

Returns:

isPerAvgRule

public boolean isPerAvgRule()

returns true if this rule uses period average evaluation

Overrides:

isPerAvgRule in class OpRule

Returns:

default is false

setReservoirIndex

public void setReservoirIndex(int resIndex)

accessor method to set the reservoir index

Parameters:

resIndex - reservoir index

getReservoirIndex

public int getReservoirIndex()

accessor method that returns the reservoir index

Returns:

reservoir index

getTandemReservoir

public ReservoirElement getTandemReservoir()

returns the downstream Reservoir for which this rule operates. Assumes that the getSystem() returns a valid RssSystem and that the reservoirIndex is a valid ReservoirElement index.

Returns:

getRuleLimitType

public int getRuleLimitType()

Description copied from class: OpRule

get the limit type of this rule should be implemented by all subclasses of OpRule

Overrides:

getRuleLimitType in class OpRule

initializeCompute

public boolean initializeCompute()

called at the begining of the computation

Overrides:

initializeCompute in class OpRule

Returns:

true if successful

evaluateRule

public OpValue evaluateRule(RunTimeStep rts,
 double initialValue,
 int iteration,
 boolean evalDownstream)

compares the intial value to rule constraints and returns the adjusted value

Overrides:

evaluateRule in class OpRule

outputReport

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

Description copied from interface: AltInputReportInfc

Alternative Input Report Interface for data.

Specified by:

outputReport in interface AltInputReportInfc

Overrides:

outputReport in class OpRule

getWaterAccount

public WaterAccount getWaterAccount()

Description copied from interface: DemandRuleInf

Gets the water account.

Specified by:

getWaterAccount in interface DemandRuleInf

Returns:

the water account

setWaterAccount

public void setWaterAccount(WaterAccount wa)

Description copied from interface: DemandRuleInf

Sets the water account.

Specified by:

setWaterAccount in interface DemandRuleInf

Parameters:

wa - the new water account