Package hec.rss.model

Class WaterQualityOpRule

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssTSLocationObject
hec.rss.model.OpRule
hec.rss.model.ReleaseFuncOpRule
hec.rss.model.WaterQualityOpRule
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, TSLocation, DemandRuleInf, AltInputReportInfc, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
public class WaterQualityOpRule extends ReleaseFuncOpRule
See Also:

  • Field Details

    • logger

      public static final Logger logger

  • Constructor Details

    • WaterQualityOpRule

      public WaterQualityOpRule()

    • WaterQualityOpRule

      public WaterQualityOpRule(String name)
      Parameters:
      name -

  • Method Details

    • getDownstreamControlLocationID

      public int getDownstreamControlLocationID()
      returns the integer _downstreamLocationID, -1 indicates local limit.

    • setDownstreamControlLocationID

      public void setDownstreamControlLocationID(int id)
      sets the _downstreamLocationID, -1 indicates local limit.

    • getConstituentName

      public String getConstituentName()

    • setConstituentName

      public void setConstituentName(String constituentName)

    • getReleaseType

      public WaterQualityOpReleaseType getReleaseType()

    • setReleaseType

      public void setReleaseType(WaterQualityOpReleaseType releaseType)

    • initializeCompute

      public boolean initializeCompute()
      Description copied from class: ReleaseFuncOpRule
      prep for compute
      Overrides:
      initializeCompute in class ReleaseFuncOpRule

    • evaluateRule

      public void evaluateRule(RunTimeStep rts, int iteration)

    • evaluateRuleContinuousIntake

      public void evaluateRuleContinuousIntake(RunTimeStep rts, int iteration)

    • evaluateRuleGatedIntake

      public void evaluateRuleGatedIntake(RunTimeStep rts, int iteration)

    • getWQOpValue

      public hec.rss.wq.model.WQOpValue getWQOpValue()

    • setWQControlDeviceElev

      public void setWQControlDeviceElev(double opElev)

    • getWaterControlDevice

      public WaterControlDevice getWaterControlDevice()

    • getActiveTSRecordProxies

      public Vector getActiveTSRecordProxies(Vector vec, int iotype)
      Description copied from class: ReleaseFuncOpRule
      add the time series record proxies associated current compute
      Overrides:
      getActiveTSRecordProxies in class ReleaseFuncOpRule

    • updateTSProxyList

      public void updateTSProxyList()
      Description copied from class: ReleaseFuncOpRule
      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 ReleaseFuncOpRule

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from class: ReleaseFuncOpRule
      Called just before ascii serialization. Prepares the paired data values by setting there dss record path names
      Specified by:
      getFieldObject in interface FieldAccessor
      Overrides:
      getFieldObject in class ReleaseFuncOpRule
      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 ReleaseFuncOpRule
      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