Package hec.rss.model

Class FlowLimitOpRule

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssTSLocationObject
hec.rss.model.OpRule
hec.rss.model.FlowLimitOpRule
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, TSLocation, AltInputReportInfc, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
@Deprecated public class FlowLimitOpRule extends OpRule implements RssModelVariableConstants
Deprecated.
Flow Limit Operation Rule that supports maximum or minimum constraints at local or downstream locations.
See Also:

  • Field Details

  • Constructor Details

    • FlowLimitOpRule

      public FlowLimitOpRule()
      Deprecated.

    • FlowLimitOpRule

      public FlowLimitOpRule(String name)
      Deprecated.

  • Method Details

    • getElementDependencies

      public void getElementDependencies(List elemList)
      Deprecated.
      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

    • getLag

      public int getLag()
      Deprecated.
      returns the number of time steps routing delays the release measured to the peak of reponse at the control location.
      Returns:
      integer lag

    • getMaxRoutingSteps

      public int getMaxRoutingSteps()
      Deprecated.
      returns the number of time steps the release requires to completely route to the downstream control
      Returns:
      integer number of routing steps

    • updateTSProxyList

      public void updateTSProxyList()
      Deprecated.
      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

    • getActiveTSRecordProxies

      public Vector getActiveTSRecordProxies(Vector vec, int iotype)
      Deprecated.
      add the time series record proxies associated current compute
      Overrides:
      getActiveTSRecordProxies in class OpRule

    • clone

      public Object clone()
      Deprecated.
      Description copied from class: RssTSLocationObject
      clone method
      Overrides:
      clone in class OpRule

    • computePulseResponse

      public boolean computePulseResponse(RunTimeStep rts, double qpulse, double qoutlet, int pulseStep)
      Deprecated.
      compute back routing coefficients from pulse run, must be called while current pulse results are in memory

    • calculateRoutedRelease

      @Deprecated public boolean calculateRoutedRelease(RunTimeWindow rtw)
      Deprecated.
      calculate release that will exactly satisfy the rule at the down stream location must be called after regulated flow simulation while data is still in memory

    • calculateRoutedRelease_old

      @Deprecated public boolean calculateRoutedRelease_old(RunTimeWindow rtw)
      Deprecated.
      calculate release that will exactly satisfy the rule at the down stream location must be called after regulated flow simulation while data is still in memory

    • initializeCompute

      public boolean initializeCompute()
      Deprecated.
      prep for compute
      Overrides:
      initializeCompute in class OpRule

    • evaluateRule

      public OpValue evaluateRule(RunTimeStep rts, double initialValue, int iteration)
      Deprecated.
      compares the intial value to rule constraints and returns the adjusted value
      Overrides:
      evaluateRule in class OpRule

    • setInterpolationType

      public void setInterpolationType(int type)
      Deprecated.

    • getInterpolationType

      public int getInterpolationType()
      Deprecated.

    • getSeasonalRecord

      public SeasonalRecord getSeasonalRecord()
      Deprecated.
      Returns a reference to the seasonal record object containing the time varying flow limits

    • getLimitType

      public int getLimitType()
      Deprecated.
      returns the integer type of the limit: -1=Min, 1=Max

    • setLimitType

      public void setLimitType(int type)
      Deprecated.
      sets the limit type, must ether -1=Min or 1=Max

    • getRssNodeIndex

      public int getRssNodeIndex()
      Deprecated.
      returns the integer rssNodeIndex, -1 indicates local limit.

    • setRssNodeIndex

      public void setRssNodeIndex(int id)
      Deprecated.
      sets the rssNodeIndex, -1 indicates local limit.