Package hec.rss.model

Class DiversionDemandOpRule

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.rss.model.RssTSLocationObject

hec.rss.model.OpRule

hec.rss.model.DiversionDemandOpRule

All Implemented Interfaces:

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

public class DiversionDemandOpRule
extends OpRule

Diversion OpRule to handle the original Diversion Rules

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
DiversionDemandOpRule()
DiversionDemandOpRule(String name)

Method Summary

Modifier and Type	Method	Description
DiversionDemandOpRule	clone()	clone method
void	evaluateLimits(RunTimeStep rts, int iteration)	default implementation calls the old method without the iteration argument 2007-12-27
OpValue	evaluateRule(RunTimeStep rts, double initialValue, int iteration, boolean evalDownstream)	compares the intial value to rule constraints and returns the adjusted value
void	evaulatePerformance(RunTimeWindow rtw)	post processing immediately following compute to evalute performance
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.
int	getLimitType()	get the limit type, min, max, specified, demand
OpValue	getOpValue(RunTimeStep rts)
void	getReferencedStateVariables(List svlist)	adds StateVariables refereced by this rule to the given list
Rule	getRule()
int	getRuleLimitType()	get the limit type of this rule should be implemented by all subclasses of OpRule
boolean	initializeCompute()	pass initialization command to diversion rule
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
void	setLimitType(int limitType)	set the limit type, min, max, specified, demand.
void	setRule(Rule rule)
void	updateTSProxyList()	Regenerates the list of all TSProxies required for this location.

Methods inherited from class hec.rss.model.OpRule

applyHindcastData, checkRisingFallingCondition, computeStepLimit, evaluateRule, evaluateRule, getAveragingPeriod, getController, getDayOfWeekFactor, getDemandScale, getElementDependencies, getEnableRiseFallCondition, getGmtOffset, getKeyStringForObject, getLargestDayOfWeekFactor, getLargestTimeOfDayFactor, getMultiplier, getNetwork, getObjectForKeyString, getOperationsElement, getParameterType, getPowerOpValue, getPriority, getRequiredTSRecordProxies, getReservoirElement, getRiseFallCondition, getRiseFallTolerance, getRssSystem, getSystem, getTargetTSRecordProxy, getTimeOfDayFactor, getTimeOfDayMultiplier, getTSProxyName, getUnitSystem, initForPostProcessing, initOperationStep, isActive, isDnstrmRule, isLocalRule, isPerAvgRule, outputReport, resetChildOwnership, restoreFunctionState, restoreHotstartState, riseFallConditionIsValid, saveFunctionState, saveHotstartState, setAveragingPeriod, setController, setDemandScale, setEnableRiseFallCondition, 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

DiversionDemandOpRule

public DiversionDemandOpRule()

DiversionDemandOpRule

public DiversionDemandOpRule(String name)

Parameters:

name -

Method Details

setRule

public void setRule(Rule rule)

Parameters:

rule -

getRule

public Rule getRule()

initializeCompute

public boolean initializeCompute()

pass initialization command to diversion rule

Overrides:

initializeCompute in class OpRule

getRuleLimitType

public int getRuleLimitType()

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

Overrides:

getRuleLimitType in class OpRule

getReferencedStateVariables

public void getReferencedStateVariables(List svlist)

Description copied from class: OpRule

adds StateVariables refereced by this rule to the given list

Overrides:

getReferencedStateVariables in class OpRule

Parameters:

svlist - unique list of state variables

evaluateLimits

public void evaluateLimits(RunTimeStep rts,
 int iteration)

default implementation calls the old method without the iteration argument 2007-12-27

Overrides:

evaluateLimits in class OpRule

Parameters:

rts -

iteration -

evaluateRule

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

Description copied from class: OpRule

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

Overrides:

evaluateRule in class OpRule

getOpValue

public OpValue getOpValue(RunTimeStep rts)

Overrides:

getOpValue in class OpRule

getActiveTSRecordProxies

public Vector getActiveTSRecordProxies(Vector vec,
 int iotype)

Description copied from class: OpRule

add the time series record proxies associated current compute. subclassses that over-ride this method should also call this method

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

evaulatePerformance

public void evaulatePerformance(RunTimeWindow rtw)

post processing immediately following compute to evalute performance

Overrides:

evaulatePerformance in class OpRule

Parameters:

rtw -

clone

public DiversionDemandOpRule clone()

Description copied from class: RssTSLocationObject

clone method

Overrides:

clone in class OpRule

getLimitType

public int getLimitType()

get the limit type, min, max, specified, demand

Returns:

the limit type

setLimitType

public void setLimitType(int limitType)

set the limit type, min, max, specified, demand.

Parameters:

limitType - the new limit type

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 OpRule

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 OpRule

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